mirror of https://github.com/status-im/swarms.git
Update README.md
This commit is contained in:
parent
d53bd36309
commit
53bc7899e5
|
@ -1,6 +1,6 @@
|
|||
## Preamble
|
||||
|
||||
Idea: <to be assigned>
|
||||
Idea: 146-status-go-sdk
|
||||
Title: Status GO-SDK
|
||||
Status: Draft
|
||||
Created: 2018-04-03
|
||||
|
@ -100,9 +100,12 @@ Description: TBD
|
|||
Testing Days required: TBD
|
||||
|
||||
## Success Metrics
|
||||
TBD
|
||||
<!-- Assuming the idea ships, what would success look like? What are the most important metrics that you would move?
|
||||
|
||||
- A dev who is unfamiliar with the SDK is able to set up his environment and build a simple chatbot in under 2 hours, just by following the documentation.
|
||||
|
||||
#### Exit criteria:
|
||||
|
||||
Same as success metrics.
|
||||
|
||||
## Supporting Role Communication
|
||||
<!-- Once Requirements and Goals are fleshed out, then it should be communicated to supporting organelles if required -->
|
||||
|
|
|
@ -0,0 +1,43 @@
|
|||
## SDK Iterations
|
||||
|
||||
|
||||
### Protocol messages
|
||||
|
||||
[New protocol spec](https://docs.google.com/document/d/1Qh2h07T_qepzEJ7IytmxwIdQAOsGHrvhXwZxuZtbwgc/edit#) clearly defines all message types with examples. It's based on [transit-format](https://github.com/cognitect/transit-format), so it makes sense to evaluate its [go implementation](https://github.com/russolsen/transit)
|
||||
|
||||
Use cases:
|
||||
|
||||
### General
|
||||
#### [ ] Message
|
||||
|
||||
##### Parameters:
|
||||
- content: the content of the message (a map or a string for now)
|
||||
- content-type: the content-type of the message
|
||||
- message-type: the type of the message
|
||||
- to-clock-value : the clock of the sender for message ordering
|
||||
- timestamp: the timestamp of message
|
||||
|
||||
*Where does the destination/s of the message is defined?*
|
||||
|
||||
|
||||
#### Private groups
|
||||
|
||||
##### [ ] NewGroupKey
|
||||
|
||||
- [ ] GroupAdminUpdate
|
||||
- [ ] GroupLeave
|
||||
|
||||
#### Contact management
|
||||
- [ ] NewContactKey
|
||||
- [ ] ContactRequest
|
||||
- [ ] ContactRequestConfirmed
|
||||
- [ ] ContactUpdate
|
||||
|
||||
#### Not needed for first iteration
|
||||
- [ ] Seen
|
||||
|
||||
|
||||
##### Message
|
||||
|
||||
|
||||
### Define final SDK UI based on different messages
|
Loading…
Reference in New Issue