Skip to content

Commit f69508c

Browse files
authored
Update README.md
1 parent 91278bc commit f69508c

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cooper Control Tool
1+
# COOPER Control Tool
22

33
[![Travis](https://img.shields.io/travis/hardwario/cpgw/master.svg)](https://travis-ci.org/hardwario/cpgw)
44
[![Release](https://img.shields.io/github/release/hardwario/cpgw.svg)](https://github.com/hardwario/cpgw/releases)
@@ -8,7 +8,8 @@
88

99
This is the Gateway tool for cooper dongle
1010

11-
## Installing
11+
12+
## Installation
1213

1314
You can install **cpgw** directly from PyPI:
1415

@@ -19,7 +20,8 @@ sudo pip3 install -U cpgw
1920

2021
> Note: You may need to use `sudo` before the command - it depends on the operating system used...
2122
22-
## Config
23+
24+
## Configuration
2325

2426
Insert this snippet to the file /etc/cooper/cpgw.yml:
2527
```
@@ -33,17 +35,17 @@ zmq:
3335
port: 5681
3436
```
3537

36-
## Usage
3738

38-
### As cli tool
39+
## Usage
3940

4041
```sh
4142
cpgw -c /etc/cooper/cpgw.yml
4243
```
4344

44-
### Systemd
4545

46-
Insert this snippet to the file /lib/systemd/system/cpgw.service:
46+
### Start using systemd
47+
48+
Insert this snippet to the file `/etc/systemd/system/cpgw.service`:
4749
```
4850
[Unit]
4951
Description=COOPER cpgw
@@ -74,12 +76,13 @@ View the service log:
7476
journalctl -u cpgw.service -f
7577

7678

77-
### PM2
79+
### Start using PM2
80+
7881
```sh
7982
pm2 start `which python3` --name "cpgw" -- `which cpgw` -c /etc/cooper/cpgw.yml
8083
```
8184

82-
### As library
85+
### Usage as Python module
8386

8487
```python
8588
from cpgw.gateway import Gateway

0 commit comments

Comments
 (0)