Skip to content

Commit

Permalink
added examples
Browse files Browse the repository at this point in the history
  • Loading branch information
adl212 committed Dec 20, 2020
1 parent 296b437 commit 6700a60
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,33 @@
* gets team stats
* access the nitrotype api
## Racer Class
Get the stats of a racer.
### Arguments
* username

How to use it:
```python
import nitrotype
racer = nitrotype.Racer('adl212')
print(racer.username)
```
You can see all the attributes [here](#racer-attributes)
This will print out adl212
You can see all the attributes of the Racer class [here](#racer-attributes)

## Team Class
Get the stats of a team.
### Arguments
* team tag

How to use it:
```python
import nitrotype
team = nitrotype.Team('NTA')
print(team.leaders)
```
This will print out officers and the captain by type tuple (**username**, **displayname**)
You can see all the attributes of the Team class [here](#team-attributes)

# Racer Attributes

# Team Attributes

0 comments on commit 6700a60

Please sign in to comment.