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.

Sign up for GitHub

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

Jump to bottom

Include a basic README for crates.io #1025

Closed
SilentCicero opened this issue Jul 2, 2023 · 0 comments · Fixed by #1026
Closed

Include a basic README for crates.io #1025

SilentCicero opened this issue Jul 2, 2023 · 0 comments · Fixed by #1026
Assignees
@Br1ght0ne
Labels
documentation Improvements or additions to documentation

Comments

@SilentCicero
Copy link

When viewing the fuels package in crates.io, there is no README found, this should at least include the basic and relevant information for using the SDK.

Thoughts?

Screen Shot 2023-07-02 at 7 10 07 PM
@SilentCicero SilentCicero added the documentation Improvements or additions to documentation label Jul 2, 2023
@Br1ght0ne Br1ght0ne mentioned this issue Jul 3, 2023
Merged
6 tasks
@Br1ght0ne Br1ght0ne self-assigned this Jul 3, 2023
Br1ght0ne added a commit that referenced this issue Jul 4, 2023
@Br1ght0ne
docs: show README.md for fuels on crates.io (#1026)
cefc561 
Should show the top-level `README.md` for `fuels` (`packages/fuels`) on
[crates.io](https://crates.io/crates/fuels).
Not sure on how to test this besides merging and cutting a release to
check crates.io.

Close #1025.

### Checklist
- [x] I have linked to any relevant issues.
- [x] I have updated the documentation.
- [ ] I have added tests that prove my fix is effective or that my
feature works.
- [x] I have added necessary labels.
- [x] I have done my best to ensure that my PR adheres to [the Fuel Labs
Code Review
Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md).
- [x] I have requested a review from the relevant team or maintainers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Br1ght0ne Br1ght0ne

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: show README.md for fuels on crates.io FuelLabs/fuels-rs
2 participants
@SilentCicero @Br1ght0ne