chore: update READMEs (client, api, repo root)

storacha / w3name

IPNS client and service for generating, updating, and tracking immutable names with signed updates

Other

45 stars 12 forks source link

chore: update READMEs (client, api, repo root) #51

Closed yusefnapora closed 2 years ago

yusefnapora commented 2 years ago

This adds a bit of context to some of the example snippets in the client README.

TODO:

[x] update link to API docs

Also TODO, but possibly in a separate PR:

[x] add overview of routes to packages/api/README.md
[x] update main monorepo README
- [x] wrap up remaining TODOs in the text
- [x] add quick intro / links to IPNS docs, etc

yusefnapora commented 2 years ago

Hey @joshJarr, I noticed you added a link to the how-to in #55 - I went ahead and cherry-picked that into here, but feel free to merge that one now if you guys need time to review this PR.

yusefnapora commented 2 years ago

Awesome, thanks @joshJarr :) I'll merge this in and you can add the swagger link.