diff options
author | Case Duckworth | 2020-05-10 19:06:03 -0500 |
---|---|---|
committer | Case Duckworth | 2020-05-10 19:08:36 -0500 |
commit | 889d918bca719997e95fac4549ed30a38f281312 (patch) | |
tree | 301bd8e715b859cd9ffb3ed7b4edb0ea1a9f8b62 /README.md | |
parent | Enable licenser_source to be set by env (diff) | |
download | licensor-889d918bca719997e95fac4549ed30a38f281312.tar.gz licensor-889d918bca719997e95fac4549ed30a38f281312.zip |
Update README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 48 |
1 files changed, 32 insertions, 16 deletions
diff --git a/README.md b/README.md index 563582a..daad839 100644 --- a/README.md +++ b/README.md | |||
@@ -13,22 +13,38 @@ Done. | |||
13 | literally taken from `licenser -h` | 13 | literally taken from `licenser -h` |
14 | 14 | ||
15 | ``` | 15 | ``` |
16 | licenser [-h|-l] [-y YEAR] [-a AUTHOR] [-o FILE] LICENSE | 16 | licenser: plop a license in your project |
17 | 17 | ||
18 | -h show this help and exit | 18 | usage: licenser [-h|-m|-M] |
19 | -l list available licenses and exit | 19 | licenser [-f] [-q] [-y YEAR] [-a AUTHOR] [-e EMAIL] |
20 | -f overwrite existing license | 20 | [-l LANG] [-o FILE] [LICENSE] |
21 | -y YEAR set the copyright date to YEAR | 21 | flags: |
22 | -a AUTHOR set the copyright holder to AUTHOR | 22 | -h show this help and exit |
23 | -o FILE output to FILE | 23 | -m list available licenses and exit |
24 | LICENSE which license to use | 24 | -M list licenses, disregarding cached manifest |
25 | 25 | -f overwrite existing license | |
26 | YEAR defaults to the current year. | 26 | -q quiet: don't log anything |
27 | AUTHOR is guessed by the following, in order: | 27 | options: |
28 | - git config --get user.name | 28 | -y YEAR set copyright date(s) to YEAR. |
29 | - getent passwd $USER | 29 | default: $(date +%Y). |
30 | - $USER | 30 | this option accepts arbitrary input. |
31 | FILE defaults to LICENSE in the current directory | 31 | -a AUTHOR set copyright holder(s) to AUTHOR. |
32 | default: | ||
33 | - git config --get user.name | ||
34 | - getent password $USER | ||
35 | - $USER | ||
36 | -e EMAIL set AUTHOR's email address to EMAIL. | ||
37 | default: | ||
38 | - git config --get user.email | ||
39 | - [blank] | ||
40 | -l LANG set license language to LANG. | ||
41 | default: 'en' (subject to change) | ||
42 | -o FILE set output file to FILE. | ||
43 | default: LICENSE in $PWD | ||
44 | parameters: | ||
45 | LICENSE which license to use. | ||
46 | default: $LICENSER_LICENSE, which | ||
47 | defaults to MIT. | ||
32 | ``` | 48 | ``` |
33 | 49 | ||
34 | ## Contributing | 50 | ## Contributing |