Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cheton authored May 2, 2017
1 parent c6d1ffd commit 3d4eae0
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ pi@rpi3$ cnc -h
-w, --watch-directory <path> watch a directory for changes
--access-token-lifetime <lifetime> access token lifetime in seconds or a time span string (default: 30d)
--allow-remote-access allow remote access to the server
--controller <type> specify CNC controller: Grbl|Smoothie|TinyG (default: '')
Examples:
Expand All @@ -120,14 +121,16 @@ pi@rpi3$ cnc -h
$ cnc --watch-directory /home/pi/watch
$ cnc --access-token-lifetime 60d # e.g. 3600, 30m, 12h, 30d
$ cnc --allow-remote-access
$ cnc --controller Grbl
```

Instead of passing command line options for `--watch-directory`, `--access-token-lifetime`, and `--allow-remote-access`, you can create a `~/.cncrc` file that contains the following configuration in JSON format:
Instead of passing command line options for `--watch-directory`, `--access-token-lifetime`, `--allow-remote-access`, and `--controller`, you can create a `~/.cncrc` file that contains the following configuration in JSON format:
```json
{
"watchDirectory": "/path/to/dir",
"accessTokenLifetime": "30d",
"allowRemoteAccess": false
"allowRemoteAccess": false,
"controller": ""
}
```

Expand Down Expand Up @@ -156,9 +159,16 @@ Check out an example configuration file [here](https://github.com/cncjs/cncjs/bl

```json
{
"ports": [
{
"comName": "/dev/ttyAMA0",
"manufacturer": ""
}
],
"watchDirectory": "/path/to/dir",
"accessTokenLifetime": "30d",
"allowRemoteAccess": false,
"controller": "",
"state": {
"checkForUpdates": true
},
Expand Down

0 comments on commit 3d4eae0

Please sign in to comment.