search

allan2 / dotenvy

A well-maintained fork of the Rust dotenv crate
MIT License
625 stars 39 forks source link

Would a PR to add an example to the README.md be accepted? #92

Open chmorgan opened 4 months ago

chmorgan commented 4 months ago

sqlx links to dotenv for examples (https://github.com/launchbadge/sqlx) and having the examples in dotenvy README.md would let me open a PR against sqlx to point here instead.

I started using sqlx, discovered the concept of a .env file and followed the links to dotenv, noticed it appeared stale for years and it took several minutes to figure out what was going on and to stumble upon dotenvy as a maintained version.

allan2 commented 4 months ago

It took me a bit to understand your request, but I think I got it:

The sqlx README has a hyperlink to dotenv-rs/dotenv. This repo does not have an example of the .env file (or environment variable). You would like that included in the README of this repo.

Is that correct?

If so, I could add an example to dotenvy's README like so:

FOO=bar
MEANING_OF_LIFE=42

And then you could open a PR for sqlx.

I'd also suggest linking to the repo page itself (https://github.com/allan2/dotenvy) rather than a section, since the README is rather short (and will stay that way).

aidenfarley commented 3 months ago

This is the exact same place I came from. I was using sqlx, and I saw the dotenv deprecation. I found this repository, and at the time I wanted to make an issue for this. I didn't end up having the time to find whether an issue for it already existed, but now I have.

@allan2 what you're stating is exactly what chmorgan means, and is the issue that prevents sqlx from using this repository for the documentation.

aidenfarley commented 3 months ago

What, if anything, is preventing #98 from being merged? That will close both this issue and the allow merge of the corresponding PR on sqlx.