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

Expand implementations list #7

Open
wants to merge 5 commits into
base: gh-pages
Choose a base branch
from

Conversation

clehner
Copy link
Member

@clehner clehner commented Nov 18, 2021

To the list in the readme:

README.md Outdated Show resolved Hide resolved
README.md Outdated
- [digitalbazaar](https://github.com/digitalbazaar/secp256k1-key-pair)
- [spruce](https://docs.rs/ssi/0.2.0/ssi/ldp/struct.EcdsaSecp256k1Signature2019.html)

Choose a reason for hiding this comment

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

Pardon my unfamiliarity with docs.rs and rust, but is that the best link for an implementation? Looks like just API docs to me. Maybe also link to https://github.com/spruceid/ssi or wherever the code lives?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure... Originally I was going to use this link: https://github.com/spruceid/ssi/blob/15e944620e20b31b4644edad094e01ff7b418e44/src/ldp.rs#L822 but then thought it might be nicer to use the docs page. In a future version these docs should have more human-readable content. The docs.rs pages have links to the source/repository in the navigation. But maybe it would be better to just to link to the repo, as that is more intended to be an entry point...

Choose a reason for hiding this comment

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

Heh, that repo link was not obvious to me. I used a search engine. It also seems a specific 0.2.0 link would get stale easily as the lib matures. And this is getting off topic, but implementation links should probably list the implementation language(s).

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point about the version. A wildcard could be used in the docs.rs URL to refer to the latest version, but the latest release of this crate doesn't have the docs building currently. Updated to use the repo link: bc37222.

About listing the implementation languages, sure why not: 638538a

Co-authored-by: Markus Sabadello <markus@danubetech.com>
@clehner clehner changed the title Link to Spruce implementation Link to more implementations Nov 19, 2021
@clehner clehner marked this pull request as draft November 19, 2021 00:32
@clehner clehner changed the title Link to more implementations Expand implementations list Nov 19, 2021
@clehner clehner marked this pull request as ready for review November 19, 2021 14:57
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.

3 participants