Added django-requirements.txt to the .travis.yml and updated README

capless · Apr 11, 2017 · a53cb08 · a53cb08
1 parent 721aa71
commit a53cb08
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -9,5 +9,6 @@ python:
 # command to install dependencies
 install: "pip install nose coverage"
 install: "pip install -r requirements.txt"
+install: "pip install -r django-requirements.txt"
 # command to run tests
 script: nosetests
diff --git a/README.md b/README.md
@@ -99,6 +99,13 @@ u = Cognito('your-user-pool-id','your-client-id')
 
 u.register('username','password',email='you@you.com',some_random_attr='random value') #**kwargs are the other attributes that should be set ex. email, given_name, family_name
 ```
+##### Arguments
+
+- **username:** User Pool username
+- **password:** User Pool password
+- **attr_map:** Attribute map to Cognito's attributes
+- **kwargs:** Additional User Pool attributes ex. **{'email':'you@you.com'}
+
 
 #### Authenticate ####
 
@@ -219,6 +226,9 @@ u = Cognito('your-user-pool-id','your-client-id',
 
 u.check_token()
 ```
+##### Arguments
+
+No arguments for check_token
 
 #### Logout ####