Skip to content

Commit 54882b4

Browse files
committed
List the varsets in the README.
1 parent 315ef1a commit 54882b4

File tree

2 files changed

+49
-1
lines changed

2 files changed

+49
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@
2525
cargo add getenv
2626
```
2727

28+
```toml
29+
getenv = 0.1
30+
```
31+
32+
```toml
33+
getenv = { version = "0.1", default-features = false, features = ["posix"] }
34+
```
35+
2836
## 👉 Examples
2937

3038
### Importing the library
@@ -33,9 +41,41 @@ cargo add getenv
3341
use getenv::*;
3442
```
3543

44+
### Reading environment variables
45+
46+
```rust
47+
use getenv::aws::*;
48+
49+
println!("aws_access_key_id = {:?}", aws_access_key_id())
50+
println!("aws_secret_access_key = {:?}", aws_secret_access_key())
51+
```
52+
3653
## 📚 Reference
3754

38-
TBD
55+
Varset | Feature | Reference
56+
------ | ------- | ---------
57+
aws | `aws` | [`use getenv::aws::*;`](https://docs.rs/getenv/latest/getenv/varsets/aws/index.html)
58+
cargo | `cargo` | [`use getenv::cargo::*;`](https://docs.rs/getenv/latest/getenv/varsets/cargo/index.html)
59+
conda | `conda` | [`use getenv::conda::*;`](https://docs.rs/getenv/latest/getenv/varsets/conda/index.html)
60+
cuda | `cuda` | [`use getenv::cuda::*;`](https://docs.rs/getenv/latest/getenv/varsets/cuda/index.html)
61+
docker | `docker` | [`use getenv::docker::*;`](https://docs.rs/getenv/latest/getenv/varsets/docker/index.html)
62+
git | `git` | [`use getenv::git::*;`](https://docs.rs/getenv/latest/getenv/varsets/git/index.html)
63+
go | `go` | [`use getenv::go::*;`](https://docs.rs/getenv/latest/getenv/varsets/go/index.html)
64+
homebrew | `homebrew` | [`use getenv::homebrew::*;`](https://docs.rs/getenv/latest/getenv/varsets/homebrew/index.html)
65+
java | `java` | [`use getenv::java::*;`](https://docs.rs/getenv/latest/getenv/varsets/java/index.html)
66+
locale | `locale` | [`use getenv::locale::*;`](https://docs.rs/getenv/latest/getenv/varsets/locale/index.html)
67+
macos | `macos` | [`use getenv::macos::*;`](https://docs.rs/getenv/latest/getenv/varsets/macos/index.html)
68+
near | `near` | [`use getenv::near::*;`](https://docs.rs/getenv/latest/getenv/varsets/near/index.html)
69+
node | `node` | [`use getenv::node::*;`](https://docs.rs/getenv/latest/getenv/varsets/node/index.html)
70+
openssl | `openssl` | [`use getenv::openssl::*;`](https://docs.rs/getenv/latest/getenv/varsets/openssl/index.html)
71+
posix | `posix` | [`use getenv::posix::*;`](https://docs.rs/getenv/latest/getenv/varsets/posix/index.html)
72+
proxy | `proxy` | [`use getenv::proxy::*;`](https://docs.rs/getenv/latest/getenv/varsets/proxy/index.html)
73+
python | `python` | [`use getenv::python::*;`](https://docs.rs/getenv/latest/getenv/varsets/python/index.html)
74+
ruby | `ruby` | [`use getenv::ruby::*;`](https://docs.rs/getenv/latest/getenv/varsets/ruby/index.html)
75+
rust | `rust` | [`use getenv::rust::*;`](https://docs.rs/getenv/latest/getenv/varsets/rust/index.html)
76+
ssh | `ssh` | [`use getenv::ssh::*;`](https://docs.rs/getenv/latest/getenv/varsets/ssh/index.html)
77+
windows | `windows` | [`use getenv::windows::*;`](https://docs.rs/getenv/latest/getenv/varsets/windows/index.html)
78+
xdg | `xdg` | [`use getenv::xdg::*;`](https://docs.rs/getenv/latest/getenv/varsets/xdg/index.html)
3979

4080
## 👨‍💻 Development
4181

Rakefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ namespace :varset do
2828
puts %{pub use #{varset}::*;}
2929
end
3030
end
31+
32+
task :readme do
33+
puts %{Varset | Feature | Reference}
34+
puts %{------ | ------- | ---------}
35+
varsets.each do |varset|
36+
puts %{#{varset} | `#{varset}` | [`use getenv::#{varset}::*;`](https://docs.rs/getenv/latest/getenv/varsets/#{varset}/index.html)}
37+
end
38+
end
3139
end
3240

3341
def varsets

0 commit comments

Comments
 (0)