diff --git a/ideas/146-status-go-sdk/README.md b/ideas/146-status-go-sdk/README.md index 3dc4b16..705ac2e 100644 --- a/ideas/146-status-go-sdk/README.md +++ b/ideas/146-status-go-sdk/README.md @@ -54,8 +54,7 @@ _All methods should work for 1to1, groups and public chats._ With this methods building a simple `autoresponder bot` should be as simple as: **TO BE DEFINED** -```go - +``` // Connect to the default status url and defer closing the connection st, _ := status.Connect(st.DefaultAddr) // -> localhost:51515 defer st.Close() @@ -101,11 +100,49 @@ Testing Days required: TBD ## Success Metrics -- 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. +#### Milestone 1: Basic SDK + - [ ] Swarm participants identified + - [ ] Detailed specifications for each metric identified and documented + - [ ] User stories and project board setup + - [ ] Effort estimate and high-level schedule established -#### Exit criteria: +#### Milestone 2: Status messaging basic interaction + - [ ] Setup a new connection + - [ ] Ability to close a specific connection + - [ ] Ability to change connection configuration + - [ ] Ability to login as a specific account + - [ ] Ability to log out. -Same as success metrics. +#### Milestone 3: Public channels interaction + - [ ] Ability to join public channels + - [ ] Ability to publish messages on public channels + - [ ] Ability to subscribe to public channels + - [ ] Ability to unsubscribe from a public channel + - [ ] Documented API for public channels interaction. + - [ ] Working examples for public channel interaction. + +#### Milestone 4: Private groups interaction + - [ ] Ability to publish messages on private groups + - [ ] Ability to subscribe to private groups + - [ ] Ability to unsubscribe from a private groups + - [ ] Documented API for private groups interaction. + - [ ] Working examples for private groups interaction. + +#### Milestone 5: 1 to 1 messages interaction + - [ ] Ability to send 1 to 1 conversation + - [ ] Ability to subscribe to 1 to 1 conversation + - [ ] Ability to unsubscribe from a 1 to 1 conversation + - [ ] Documented API for 1 to 1 conversations + - [ ] Working examples for 1 to 1 conversations + + +## Exit criteria: + +This swarm will be deemed successful and be closed upon the delivery of the above milestones. + +## Success Metrics + +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. ## Supporting Role Communication