Skip to content

Commit a96365b

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

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+
```rust
56+
use getenv::aws::*;
57+
use getenv::cargo::*;
58+
use getenv::conda::*;
59+
use getenv::cuda::*;
60+
use getenv::docker::*;
61+
use getenv::git::*;
62+
use getenv::go::*;
63+
use getenv::homebrew::*;
64+
use getenv::java::*;
65+
use getenv::locale::*;
66+
use getenv::macos::*;
67+
use getenv::near::*;
68+
use getenv::node::*;
69+
use getenv::openssl::*;
70+
use getenv::posix::*;
71+
use getenv::proxy::*;
72+
use getenv::python::*;
73+
use getenv::ruby::*;
74+
use getenv::rust::*;
75+
use getenv::ssh::*;
76+
use getenv::windows::*;
77+
use getenv::xdg::*;
78+
```
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)