Skip to content

Commit

Permalink
correct README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NodeJSmith committed Jan 20, 2025
1 parent ed4f287 commit 4680f05
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,19 @@ pip install otf-api

## Overview

To use the API, you need to create an instance of the `Otf` class, providing your email address and password. This will authenticate you with the API and allow you to make requests. When the `Otf` object is created it automatically grabs your member details and home studio, to simplify the process of making requests.
To use the API, you need to create an instance of the `Otf` class. This will authenticate you with the API and allow you to make requests. When the `Otf` object is created it automatically grabs your member details and home studio, to simplify the process of making requests.

You can either pass an `OtfUser` object to the `OtfClass` or you can pass nothing and allow it to prompt you for your username and password.

See the [examples](./examples) for more information on how to use the API.
You can also export environment variables `OTF_EMAIL` and `OTF_PASSWORD` to get these from the environment.

Disclaimer:
This project is in no way affiliated with OrangeTheory Fitness.
```python
from otf_api import Otf, OtfUser

otf = Otf()

# OR

otf = Otf(user=OtfUser(<email_address>,<password>))

```

0 comments on commit 4680f05

Please sign in to comment.