Skip to content

Commit

Permalink
Add usage examples to README (close #22)
Browse files Browse the repository at this point in the history
  • Loading branch information
kemitchell committed Jan 25, 2016
1 parent 77ee096 commit 7068ea1
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,51 @@ commonform --help

`commonform-cli` is tested on the current Stable and Long Term Support (LTS) versions of [Node.js](https://nodejs.org). Please see the [Travis CI configuration file](./.travis.yml).

# Examples

You may like to download a few sample form documents to start:

```shellsession
$ git clone https://github.com/commonform/commonform-samples samples
$ cd samples
```

To format a form, say the Orrick Mutual NDA, for reading in the terminal:

```shellsession
$ commonform render Orrick-Mutual-NDA.commonform
```

To convert to OfficeOpenXML (.docx) for Microsoft Word:

```shellsession
$ commonform render --format docx Orrick-Mutual-NDA.commonform
```

And with a title:

```shellsession
$ commonform render --title "Mutual Nondisclosure Agrement" --format docx Orrick-Mutual-NDA.commonform
```

To check a form for technical errors:

```shellsession
$ commonform lint SAFE-MFN.commonform
```

And to view automated style critiques:

```shellsession
$ commonform critique IBM-Cloud-Services-Agreement.commonform
```

To see a list of additional subcommands and their options:

```shellsession
$ commonform --usage
```

# Related Projects

For [Vim](https://github.com/commonform/vim-commonform) users there is also [vim-commonform](https://github.com/commonform/vim-commonform) with syntax highlighting and conveniences for Common Form markup.

0 comments on commit 7068ea1

Please sign in to comment.