Update README to the latest version of Bandada #361
Conversation
0xjei
changed the title
0xjei
force-pushed
the
chore/update-readme
branch
from
6913fa5 to
e0e5c83
Compare
There was a problem hiding this comment.
Great job @0xjei! It feels complete yet simpler. Two comments that are general so not tied to a specific line/wording:
- Should we emphasize more the credential layer focus? (which unlocks anti-sybil and reputation layers). I feel without it we fall very similar to Semapahore use case (anonymous groups)
- Are "Code quality and formatting", "Conventional commits","Testing" mostly used when someone wants to contribute to Bandada? If so, then likely we can put them under a title like "Contributing to Bandada" and put it lower. If not, then it's fine to stay there in Usage I think.
Thank you for your review @aguzmant103 🔥
You can find the updated version in the latest commit. Please let me know if you have any |
I have incorporated your comments @aguzmant103 and @vplasencia. Thank you so much for the reviews 🔥 |
|
|
||
| Bandada consists of a back-end to store the groups and provide the [**API**](/apps/api), two front-ends: the [**dashboard**](/apps/dashboard) to manage groups and members and a [**demo**](/apps/client) application to allow end-users to join the groups, and the [**contracts**](/apps/contracts) Additionally, it also provides a set of JavaScript libraries to support developers. | ||
| Bandada comprises a versatile back-end, two user-friendly front-ends (the [**dashboard**](/apps/dashboard) to manage groups and members and a [**demo**](/apps/client) application to allow end-users to join the groups), Ethereum [**smart contracts**](/apps/contracts) for proof verification, and a collection of [**JavaScript libraries**](/libs/) for seamless integration. From the Bandada dashboard, you can effortlessly create two types of groups: **manual** and **credential** groups. In manual groups, you can add members directly or generate invite links while, in credential groups, members must demonstrate their credentials for access. Bandada provides developers with JavaScript libraries, including [`@bandada/api-sdk`](/libs/api-sdk/) to make it easier to work with the APIs. Furthermore, it provides preconfigured credential validators and allows for additional functionality through the [`@bandada/credentials`](/libs/credentials/) library. This feature allows for manual or automated management of both off-chain and on-chain groups by specifying eligibility criteria. It can be used for a variety of applications, such as organizing private organizational members, grouping contributors of a particular GitHub repository, or uniting holders of a specific NFT, among others. |
There was a problem hiding this comment.
... to make it easier to work with the APIs -> ... to make it easier to work with the API.
Since it is just one API, it would be better to put the singular version. What do you think?
There was a problem hiding this comment.
Thank you Vivi for the review ❇️
Hmm, the SDK has many APIs - so the 's' stands for the set of APIs inside the SDK itself. Does it makes sense?
There was a problem hiding this comment.
Yes, I get what you mean. What I was saying is that the SDK makes it easier to work with the Bandada API.
There was a problem hiding this comment.
Ahh, got it! Sorry. Since this PR has been merged, feel free to open an issue to track or just update through main (it's quick)!
There was a problem hiding this comment.
No worries, feel free to do it too 👍
Description
This PR presents an updated version of the Bandada README, reflecting the latest developments and revised documentation.
Does this introduce a breaking change?