Skip to content

Commit 42b4f3e

Browse files
author
Cameron Brandon White
committed
Updated README.md
1 parent 934a923 commit 42b4f3e

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

+32
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,35 @@ acmlib
55

66
Library for @pdxacm
77

8+
## Installation
9+
10+
You can use pip to download and install straight from github
11+
12+
```sh
13+
pip install git+git://github.com/pdxacm/acmlib-py.git#egg=acmlib
14+
```
15+
16+
## First steps
17+
18+
```python
19+
from acmlib import AcmLib
20+
21+
acmlib = AcmLib(username, password)
22+
```
23+
24+
## Examples
25+
26+
### Get all events
27+
28+
```python
29+
events = acmlib.get_events()
30+
31+
for event in events:
32+
print(event.title)
33+
```
34+
35+
### Add a person
36+
37+
```python
38+
new_person = acmlib.add_person(username, password)
39+
```

0 commit comments

Comments
 (0)