Skip to content

Commit f6f2746

Browse files
committed
Setup documentation
* README.md is now useful! * update the sample config file to contain all the config options
1 parent ba49bfc commit f6f2746

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
11
# ghi-assist
22
Bot that organizes Github Issues
3+
4+
## Installation
5+
(virtualenv preferred)
6+
python setup.py install
7+
8+
## Tests
9+
py.test tests
10+
11+
## Running
12+
13+
### Configuration
14+
Sample configuration is provided in `etc/config/sample.json`.
15+
16+
cp etc/config.sample.json etc/config.json
17+
18+
### Usage
19+
python bin/server.py

etc/config.sample.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,9 @@
1717
"severity: major": "severity: (2) major",
1818
"severity: critical": "severity: (3) critical"
1919
}]
20+
},
21+
"server": {
22+
"host": "localhost",
23+
"port": "8080"
2024
}
2125
}

0 commit comments

Comments
 (0)