Skip to content

Commit

Permalink
Fix readme to relate to current project
Browse files Browse the repository at this point in the history
  • Loading branch information
HookyQR committed May 15, 2019
1 parent 3a5dd03 commit 69cd071
Showing 1 changed file with 6 additions and 16 deletions.
22 changes: 6 additions & 16 deletions README.md
Expand Up @@ -2,21 +2,11 @@
[![Travis (.org) branch](https://img.shields.io/travis/jsspec/cli-options/master.svg?logo=travis&style=for-the-badge)](https://travis-ci.org/jsspec/cli-options)
[![AppVeyor](https://img.shields.io/appveyor/ci/HookyQR/cli-options/master.svg?logo=appveyor&style=for-the-badge)](https://ci.appveyor.com/project/HookyQR/cli-options)

Command line options parser for jsspec.
Default output formatters for jsspec

Example:
```javascript
const CLIOptions = requrie('@jsspec/cli-options')
Fomatters included:
## `Null`
Does nothing. Use with `--format null`. Can be used as a base class to create other formatters.

options = {
random: { alias: 'R', type: Boolean, required: false, default: true },
require: { alias: 'r', type: Array, required: false, default: [] },
format: { alias: 'f', type: String, required: false, default: 'documentation' },
files: { type: Array, required: false, default: [] }
};

const cliOptions = new CLIOptions(process.argv.slice(2), options, 'files');
const settings = cliOptions.settings;

console.log(cliOptions.errors.join('\n'));
```
## `Documentation`
`-fd` or `--format documentation`. Currently does nothing. Pre-release creation.

0 comments on commit 69cd071

Please sign in to comment.