Skip to content

Commit

Permalink
Add script's options
Browse files Browse the repository at this point in the history
  • Loading branch information
parmentf committed Jun 18, 2014
1 parent 0f5e949 commit fbccf4d
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,35 @@

ECTOR is a learning chatterbot. This is an interactive command to ECTOR.

## Getting Started
Install the module with: `npm install ector-command`
## Installation
Install the module with: `npm install -g ector-command`

## Usage

```bash
$ ector
```

## Documentation
_(Coming soon)_
## Parameters

### Name of the utterer
`-p, --person [name]`: set the name of the utterer (the user) - default value: `User`.

### Name of the bot
`-b, --botname [botname]`: set the name of the bot - default value: `ECTOR` (all uppercase).

### Quiet
`-q, --quiet`: the bot won't answer, only learn.

### Log
`-l, --log [filepath]`: log the dialogue in log file - default value: `ector.log`.

### Help
`-h, --help`: display the parameters of the command.

### Version
`-V, --version`: output the version number.


## Examples
_(Coming soon)_
Expand Down

0 comments on commit fbccf4d

Please sign in to comment.