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

docs: adds usage example #98

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ethan-sargent
Copy link

  • includes a simple example under Usage.
  • links to the dotenv crate for details on variable substitution.

Fixes: #92

@aidenfarley
Copy link

Might I suggest renaming this PR to something more verbose. Such as "Include usage examples in README.md"?

@ethan-sargent ethan-sargent changed the title docs: update README.md docs: adds usage example Apr 18, 2024
@ethan-sargent
Copy link
Author

@aidenfarley updated to improve summary clarity, I don't think its necessary to specify which file I've changed when its the only file in the diff though.

@ethan-sargent
Copy link
Author

@allan2 keen to get this merged and close out my sqlx PR, any blockers?

@aidenfarley
Copy link

Agreed. I just included it as you had included it in the original name.

@ethan-sargent
Copy link
Author

@aidenfarley to be honest, I just added docs to the start of the default commit message from Github, and didn't give it much consideration beyond that 😅 good call though!

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

Successfully merging this pull request may close these issues.

Would a PR to add an example to the README.md be accepted?
3 participants