Skip to content

Commit 3764a72

Browse files
committed
Update README.md
Add comments to readme
1 parent 527bc70 commit 3764a72

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@ Python-Hackpad-API
33

44
A simple wrapper library for the Hackpad API. [Hackpad API Documentation](https://hackpad.com/Public-Hackpad-API-Draft-nGhsrCJFlP7)
55

6+
Installation
7+
==================
8+
9+
Navigate to the folder where you have downloaded this repo, and type
10+
11+
```
12+
easy_install .
13+
```
14+
15+
into your terminal / command prompt.
616

717
Usage
818
==================
@@ -11,3 +21,9 @@ Usage
1121
temp = Hackpad('your_hackpad_subdomain','your_hackpad_client_id','your_hackpad_secret')
1222
my_hackpads = temp.list_all()
1323
````
24+
25+
Note:
26+
27+
* For `your_hackpad_subdomain`, just type the stem, not the full domain name (i.e. `mysubdomain`, not `http://mysubdomain.hackpad.com`, etc).
28+
* Your Client ID and Secret for the different subdomains you are signed into. Make sure to use the correct keys for the subdomain you are signing into.
29+

0 commit comments

Comments
 (0)