From 889d918bca719997e95fac4549ed30a38f281312 Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Sun, 10 May 2020 19:06:03 -0500 Subject: Update README --- README.md | 48 ++++++++++++++++++++++++++++++++---------------- 1 file 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. literally taken from `licenser -h` ``` -licenser [-h|-l] [-y YEAR] [-a AUTHOR] [-o FILE] LICENSE - - -h show this help and exit - -l list available licenses and exit - -f overwrite existing license - -y YEAR set the copyright date to YEAR - -a AUTHOR set the copyright holder to AUTHOR - -o FILE output to FILE - LICENSE which license to use - - YEAR defaults to the current year. - AUTHOR is guessed by the following, in order: - - git config --get user.name - - getent passwd $USER - - $USER - FILE defaults to LICENSE in the current directory +licenser: plop a license in your project + +usage: licenser [-h|-m|-M] + licenser [-f] [-q] [-y YEAR] [-a AUTHOR] [-e EMAIL] + [-l LANG] [-o FILE] [LICENSE] +flags: + -h show this help and exit + -m list available licenses and exit + -M list licenses, disregarding cached manifest + -f overwrite existing license + -q quiet: don't log anything +options: + -y YEAR set copyright date(s) to YEAR. + default: $(date +%Y). + this option accepts arbitrary input. + -a AUTHOR set copyright holder(s) to AUTHOR. + default: + - git config --get user.name + - getent password $USER + - $USER + -e EMAIL set AUTHOR's email address to EMAIL. + default: + - git config --get user.email + - [blank] + -l LANG set license language to LANG. + default: 'en' (subject to change) + -o FILE set output file to FILE. + default: LICENSE in $PWD +parameters: + LICENSE which license to use. + default: $LICENSER_LICENSE, which + defaults to MIT. ``` ## Contributing -- cgit 1.4.1-21-gabe81