Environment variable usage is not documented

electron / get

Download Electron release artifacts

https://npm.im/@electron/get

MIT License

344 stars 105 forks source link

Environment variable usage is not documented #126

Closed craxal closed 4 years ago

craxal commented 5 years ago

While skimming the source code, I noticed that the mirror URL can also be constructed from environment variables, and not just an options object. What's more, the environment variables take preference over the options object. Not sure if it was intended to leave this little detail out.

Unless that's intended, documentation for this package isn't that great. I'd love to see this improved.

malept commented 5 years ago

We're happy to review a pull request to make this better!

electron-bot commented 4 years ago

:tada: This issue has been resolved in version 1.10.0 :tada:

The release is available on:

npm package (@latest dist-tag)
GitHub release

Your semantic-release bot :package::rocket: