Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update list of implementations #92

Merged
merged 2 commits into from
Aug 13, 2024

Conversation

kentbull
Copy link
Contributor

Add in the WebOfTrust, Human Colossus Foundation, Wenjing Chu, DIF KERI Go, and Simple SSI work.

Add in the WebOfTrust, Human Colossus Foundation, Wenjing Chu, DIF KERI Go, and Simple SSI work.
README.md Outdated Show resolved Hide resolved
README.md Outdated
| CESR Library | [cesrox](https://github.com/THCLab/cesrox) | Rust | Human Colossus Foundation | Some development | [0.1.4](https://crates.io/crates/cesrox/0.1.4) | 75%+ |
| CESR | [simple-cesr](https://github.com/simple-ssi/simple-cesr) | Typescript | Future Forge | Release + Active development | [0.2.3](https://www.npmjs.com/package/@simple-ssi/simple-cesr/v/0.2.3) | ? |
| KERI core | [kerigo](https://github.com/decentralized-identity/kerigo) | Go | DIF community members | Little development | No released versions | ? |


The keripy implementation is Apache-2.0 licensed as are all repositories in the WebOfTrust project.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest to replace that line with information in above table.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Showing the License on each line is probably a good idea.

README.md Outdated
| CESR Library | [cesride](https://github.com/WebOfTrust/cesride) | Rust | WebOfTrust community | Release; inactive | [0.6.4](https://crates.io/crates/cesride/0.6.4) | 90% |
| Trust Spanning Protocol | [tsp](https://github.com/openwallet-foundation-labs/tsp) | Rust | ToIP and OpenWallet community | Prototype | N/A | ? |
| KERI core | [keriox](https://github.com/THCLab/keriox) | Rust | Human Colossus Foundation | Release + Active development | [0.11.0](https://crates.io/crates/keri-core/0.11.0) | 75%+ |
| CESR Library | [cesrox](https://github.com/THCLab/cesrox) | Rust | Human Colossus Foundation | Some development | [0.1.4](https://crates.io/crates/cesrox/0.1.4) | 75%+ |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would suggest to pick some more descriptive statuses. In case of HCF cesrox "Some development" is not correct, it is implemented CESR spec 1.0 (released) which is in use and maintained by HCF. I think community would be interested if it is maintained and/or stable release which is ready to be used.

Maybe as well compatibility with spec version (but this would require more work which don't think we can have some test suite to test against)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is a good idea. I will put in maintained/stable release info

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added clarification for implementation of CESR 1.0 and KERI 1.0. Let me know if I missed anything.

@kentbull kentbull force-pushed the implementation-list-update branch 3 times, most recently from 1d9f126 to 84c58b7 Compare July 25, 2024 16:32
@kentbull kentbull force-pushed the implementation-list-update branch from 84c58b7 to 76143f6 Compare July 25, 2024 16:33
@m00sey m00sey requested review from mitfik and m00sey and removed request for mitfik July 30, 2024 14:11
@lorenzleutgeb
Copy link

As a newcomer...

CESR 1 vs. 2

You refer to two distinct versions of CESR in the table of implementations. Via Discord I found out that CESR 1 has no spec and is implicit from KERIpy's behaviour, and that CESR 2 is what's being specced. It would be very helpful to mention this distinction in some way. Generally, I would be wary of a name clash, since as soon as the CESR spec is finalized, I would expect it to be called CESR 1, which clashes.

WebOfTrust/KERIde

... seems to be missing from the table of implementations.

/cc @FintanH check out this PR.

@kentbull
Copy link
Contributor Author

kentbull commented Aug 8, 2024

Yes, you're correct, there isn't an explicit CESR 1.0 spec, though it bears repeating here that there are two different versions. I don't think this readme is the right place to distinguish them, though we could link to a place that does fully specify the difference between the versions, which is critically important for those building CESR parsers.

I did not add WebOfTrust/keride because it doesn't work yet.

@m00sey m00sey merged commit a206a5a into WebOfTrust:main Aug 13, 2024
@kentbull kentbull deleted the implementation-list-update branch August 13, 2024 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants