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

status of subdirectories in project READMEs #69

Closed
hxrts opened this issue Apr 5, 2021 · 3 comments
Closed

status of subdirectories in project READMEs #69

hxrts opened this issue Apr 5, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@hxrts
Copy link
Contributor

hxrts commented Apr 5, 2021

I've had a few people ask me about the rust transaction builder and I've pointed them to this repo, however if the readme for that project said a little more about what's currently supported/unsupported and maturity I think that may help newbies.

@hxrts hxrts added the documentation Improvements or additions to documentation label Apr 5, 2021
@tac0turtle
Copy link
Member

We should also add docs on how to use this repo, some examples would go a long way.

When we get some short examples we can work on rendering it on the docs.cosmos.network site.

@tony-iqlusion
Copy link
Member

I'll add usage docs after I have an end-to-end test written and know it actually works 😉

@tony-iqlusion
Copy link
Member

#150 unifies the README.md and toplevel rustdoc, so it's a bit less barebones.

Please check the v0.3.0 release documentation (once I cut it) and let me know if you have further suggestions.

It's still not great but it's hopefully better than it was.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants