Merge pull request #12 from Arkoniak/update_docs

fixed docs make
Arkoniak · Apr 21, 2021 · db55a27 · db55a27
2 parents b3e49ac + 716604e
commit db55a27
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@
 
 `ConfigEnv.jl` is an environment configuration package that loads environment variables from a `.env` file into [`ENV`](https://docs.julialang.org/en/latest/manual/environment-variables/). This package was inspired by [python-dotenv](https://github.com/theskumar/python-dotenv) library and [the Twelve-Factor App](https://12factor.net/config) methodology.
 
+It's intended usage is when you have some secrets like database passwords, which shouldn't leak into public space and at the same time you want to have simple and flexible management of such secrets. Another usage possibility is when some library uses environmental variables for configuration and you want to configure them without editing your `.bashrc` or Windows environment.
+
 ## Installation
 
 `ConfigEnv.jl` is a registered package, so it can be installed with

diff --git a/docs/make.jl b/docs/make.jl
@@ -16,7 +16,7 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
-        "Usage" => "usage.md"
+        "Usage" => "usage.md",
         "Examples" => "scenarios.md"
     ],
 )

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -3,7 +3,9 @@ CurrentModule = ConfigEnv
 ```
 
 # ConfigEnv
-`ConfigEnv.jl` is an environment configuration package that loads environment variables from a `.env` file into [`ENV`](https://docs.julialang.org/en/latest/manual/environment-variables/). This package was inspired by [python-dotenv](https://github.com/theskumar/python-dotenv) library and [the Twelve-Factor App](https://12factor.net/config) methodology.
+`ConfigEnv.jl` is an environment configuration package that loads environment variables from a `.env` file into [`ENV`](https://docs.julialang.org/en/latest/manual/environment-variables/). This package was inspired by [python-dotenv](https://github.com/theskumar/python-dotenv) library and [the Twelve-Factor App](https://12factor.net/config) methodology. 
+
+It's intended usage is when you have some secrets like database passwords, which shouldn't leak into public space and at the same time you want to have simple and flexible management of such secrets. Another usage possibility is when some library uses environmental variables for configuration and you want to configure them without editing your `.bashrc` or Windows environment.
 
 ## Installation