GOMODULES
/
godotenv
mirror of https://github.com/joho/godotenv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs for the bin command.

pull/8/head v1
John Barton (joho) 2014-10-12 10:38:08 +11:00
parent d2ce5befea
commit a01a834e16
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -8,12 +8,23 @@ From the original Library:
> >
> But it is not always practical to set environment variables on development machines or continuous integration servers where multiple projects are run. Dotenv load variables from a .env file into ENV when the environment is bootstrapped. > But it is not always practical to set environment variables on development machines or continuous integration servers where multiple projects are run. Dotenv load variables from a .env file into ENV when the environment is bootstrapped.
It can be used as a library (for loading in env for your own daemons etc) or as a bin command.
There is test coverage and CI for both linuxish and windows environments, but I make no guarantees about the bin version working on windows.
## Installation ## Installation
As a library
```shell ```shell
go get github.com/joho/godotenv go get github.com/joho/godotenv
``` ```
or if you want to use it as a bin command
```shell
go get github.com/joho/godotenv/cmd/godotenv
```
## Usage ## Usage
Add your application configuration to your `.env` file in the root of your project: Add your application configuration to your `.env` file in the root of your project:
@ -85,7 +96,15 @@ myEnv, err := godotenv.Read()
s3Bucket := myEnv["S3_BUCKET"] s3Bucket := myEnv["S3_BUCKET"]
``` ```
end ### Command Mode
Assuming you've installed the command as above and you've got `$GOPATH/bin` in your `$PATH`
```
godotenv -f /some/path/to/.env some_command with some args
```
If you don't specify `-f` it will fall back on the default of loading `.env` in `PWD`
## Contributing ## Contributing