Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
blavka committed Sep 18, 2018
1 parent a9f0bfb commit 10a33c1
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Cooper Control Tool

This is the CLI tool to control cooper

## Installing

You can install **cpctl** directly from PyPI:


```sh
sudo pip3 install -U cpctl
```

> Note: You may need to use `sudo` before the command - it depends on the operating system used...
## Usage

This tool has built-in help system. Just run:

```sh
>> cpctl --help
Usage: cpctl [OPTIONS] COMMAND [ARGS]...

Cooper Control Tool.

Options:
--version Show the version and exit.
-d, --device TEXT Device path.
--help Show this message and exit.

Commands:
config Config
devices Print available devices.
node Manage the nodes

```

## License

This project is licensed under the [**MIT License**](https://opensource.org/licenses/MIT/) - see the [**LICENSE**](LICENSE) file for details.

0 comments on commit 10a33c1

Please sign in to comment.