Permalink
Browse files

Document 'types' option

  • Loading branch information...
1 parent e4874d4 commit 2264b3d497ff84dd6168912e1546f850a559aa4e @konklone konklone committed Oct 12, 2012
Showing with 4 additions and 8 deletions.
  1. +4 −8 README.md
View
12 README.md
@@ -87,17 +87,12 @@ echo "section 5362(5) of title 31" | cite
cite --input=in-file.txt --output=out-file.json
```
-To pretty-print the output:
-
-```bash
-cite "section 5362(5) of title 31" --pretty
-```
-
### Options
* `--input`: Filename to read text from
* `--output`: Filename to output text to
-* `--pretty`: prettify (indent) output
+* `--pretty`: Prettify (indent) output
+* `--types`: Limit citation types to a comma-separated list (e.g. "usc,law")
## HTTP API
@@ -139,9 +134,10 @@ Will return the results of running Citation.find() on the block of text, under a
### Options
* `text`: **required**, text to extract citations from.
-* `options[excerpt]`: include excerpts with up to this many characters around it.
* `callback`: a function name to use as a JSONP callback.
* `pretty`: prettify (indent) output.
+* `options[excerpt]`: include excerpts with up to this many characters around it.
+* `options[types]`: limit citation types to a comma-separated list (e.g. "usc,law")
## About

0 comments on commit 2264b3d

Please sign in to comment.