Skip to content

Commit 2b5f82d

Browse files
committed
update readme
1 parent 328ec6b commit 2b5f82d

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,16 @@
77

88
## Installation
99
`penv` is both a library and a command. To use the library in your own code see
10-
(godoc.org/github.com/badgerodon/penv). For the command:
10+
[the documentation](https://godoc.org/github.com/badgerodon/penv).
11+
To install the command run:
1112

1213
go get github.com/badgerodon/penv/...
1314

14-
This creates a `penv` command. Here's its usage:
15+
Here's its usage:
1516

16-
usage: penv [<flags>] <command> [<args> ...]
17-
18-
Permanently set/unset environment variables
19-
20-
Flags:
21-
--help Show help.
22-
--version Show application version.
17+
penv <command>
2318

2419
Commands:
25-
help [<command>...]
26-
Show help.
27-
2820
set <name> <value>
2921
Permanently NAME to VALUE in the environment
3022

@@ -34,5 +26,10 @@ This creates a `penv` command. Here's its usage:
3426
append <name> <value>
3527
Permanently append VALUE to NAME in the environment
3628

29+
## Gotchas
30+
Different operating systems / shells aren't really compatible. I'm able to discern which environment variables I'm responsible for with shells (like bash) by using their config files, but I can't do that with Windows or OSX. All appends will get collapsed into sets, and unsets aren't just masking the value, they may actually remove it.
31+
32+
In other words this command works but it's dangerous. If you set your `PATH` don't be surprised when it clears all the previous values and you can't get them back.
33+
3734
## License
3835
MIT

0 commit comments

Comments
 (0)