dotenvy icon indicating copy to clipboard operation
dotenvy copied to clipboard

docs: adds usage example

Open ethan-sargent opened this issue 1 year ago • 6 comments

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

Fixes: #92

ethan-sargent avatar Apr 03 '24 04:04 ethan-sargent

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

mantmorre avatar Apr 18 '24 13:04 mantmorre

@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 avatar Apr 18 '24 13:04 ethan-sargent

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

ethan-sargent avatar Apr 18 '24 13:04 ethan-sargent

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

mantmorre avatar Apr 18 '24 13:04 mantmorre

@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!

ethan-sargent avatar Apr 18 '24 14:04 ethan-sargent

Hey @allan2 just bumping this one. Any blockers?

ethan-sargent avatar Jun 21 '24 03:06 ethan-sargent

I would prefer not to link to the unmaintained repo in this repo's README.

I have just added an example env file and linked to the variable substitution rules in this repo's README. Maybe you could reopen your PR at sqlx.

allan2 avatar Sep 09 '24 16:09 allan2