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

Write a README for cargo-shuttle #71

Closed
mikeando opened this issue Mar 17, 2022 · 5 comments · Fixed by #284
Closed

Write a README for cargo-shuttle #71

mikeando opened this issue Mar 17, 2022 · 5 comments · Fixed by #284
Assignees
Milestone

Comments

@mikeando
Copy link

In the [Deploying](https://docs.rs/shuttle-service/latest/shuttle_service/#deploying) section there is a link to cargo shuttle
which links to https://docs.rs/crate/cargo-shuttle/latest.

That leads to a valid page, but its main content is cargo-shuttle-0.2.2 is not a library. which is not particularly welcoming.

@brokad
Copy link
Collaborator

brokad commented Mar 19, 2022

I agree. We should link to GH with a README.md for the cargo-shuttle crate instead.

@brokad brokad changed the title Links from documentation to cargo-shuttle is pretty useless Write a README for cargo-shuttle Mar 19, 2022
@brokad brokad added this to the v0.2.5 milestone Mar 19, 2022
@nahuakang
Copy link
Contributor

@brokad @christoshadjiaslanis Looking for something to do :) If this is still required, can you let me know what's expected on the README (like a short bullet-point outline) and I can draft something?

@chesedo
Copy link
Contributor

chesedo commented Jul 22, 2022

@nahuakang for anyone installing the cli tool this might still be nice though. A short bullet-point outline with a short description for each sub-command will be great.

Since the cli is not stable yet, I fear a proper documentation will create extra maintenance in the near future.

@nahuakang
Copy link
Contributor

@chesedo Thanks :) Then we'll keep it short and simple until the CLI is stable?

@chesedo
Copy link
Contributor

chesedo commented Jul 25, 2022

@nahuakang Yes, please 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

5 participants