diff --git a/README b/README index d4ffdda..afb91ff 100644 --- a/README +++ b/README @@ -34,7 +34,30 @@ I???+~:,,,... .=:=~I$$+, .$7?+++++=+==+~,,:==+?78DDDDDDDO88OZOO88O888 ,.....,~~==:=?$ZOZ7 .,~7IZZOZZZZOOOZO$I$Z$$Z$Z$ZZ7$I+==~DDDN8DDO$O88D8DDZO8OZ888 =+=:~::=~~:+$ZZZ$+...I77$OZ$$IIZ$?$Z7=======~=++??==,::=D8D88D8D8ZOODOOOZZ8ZOaOO -* global configs (re: ~/.bibliographe) +Installation: + +$> git clone --recursive https://github.com/gauthiier/bibliographe.git + +$> npm link + +Usage: bibliographe [options] + +Options: + --help: show this help message and exit + --data DATA + CSL json file to convert + --output {'html', 'md', 'txt'} + output format - html, markdown or plain text + default: html + --style STYLE + processor output style + see https://github.com/citation-style-language/styles-distribution + default: chicago-note-bibliography + --items [list] + list of items from the data input file to convert. + ex:["Guattari1980", "Lazzarato2014"] + default: all + +Todo: * refactor cli / lib -* system wide installation -* man page +* man page / better doc diff --git a/package.json b/package.json index e31cabb..dd99b99 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "bibliographe", "version": "0.0.1", "description": "bibliographic processor util", - "files": ["lib", "csl", "csl-locales"], + "files": ["bibliographe-cli.js", "lib", "csl", "csl-locales"], "bin": "./bibliographe-cli.js", "scripts": { "test": "echo \"HAHA! NONO!\" && exit 1"