Skip to content

Commit 1cbbc83

Browse files
committed
adding basic usage and installation information
1 parent 10af6bb commit 1cbbc83

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
11
PythonVerbalExpressions
22
=======================
3+
4+
## Installation
5+
```bash
6+
python setup.py install
7+
```
8+
9+
Hopefully you will also be able to use
10+
```bash
11+
pip install verbalexpressions
12+
```
13+
in the near future.
14+
15+
## Usage
16+
```python
17+
from verbalexpressions import VerEx
18+
verbal_expression = VerEx()
19+
```
20+
21+
## Developer setup : running the tests
22+
```bash
23+
python setup.py test
24+
```

0 commit comments

Comments
 (0)