Skip to content

Commit

Permalink
update(readme): add roadmap
Browse files Browse the repository at this point in the history
  • Loading branch information
tom-theret committed May 10, 2024
1 parent 0ea84fa commit 89c60de
Showing 1 changed file with 39 additions and 4 deletions.
43 changes: 39 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,61 @@ A simple wrapper to interact with the TurboSelf API.
> [!warning]
> This project is not affiliated with TurboSelf or INCB in any way.
## 📝 Roadmap

- [ ] Authentification

- [x] With credentials
- [ ] With token (with Pronote for example)

- [x] Reset password request (with email)

- [x] Get informations

- [x] Balance
- [x] Bookings
- [x] History
- [x] Host
- [x] Last transaction
- [x] Permissions to book evenings meals
- [x] Siblings
- [x] User

- [x] Seaching an etablishment

- [x] By city
- [x] With Limit

- [x] Get etablishment informations

- [x] Book a meal (book and cancel)

## 📦 Installation

```bash
npm install turboself-api
```

## 🔧 Usage

### Authentification with credentials

```javascript
const TurboSelf = require('turboself-api')
const TurboSelf = require("turboself-api");

async function main() {
let client = await TurboSelf.authenticateWithCredentials({ username: "your_email", password: "your_password" })
console.log(client)
let client = await TurboSelf.authenticateWithCredentials({
username: "your_email",
password: "your_password",
});
console.log(client);
}

main()
main();
```

### Other exemples

To see more examples, check the [examples](https://github.com/raphckrman/turboself-api/tree/dev/examples) folder.

## ௷ Credits
Expand Down

0 comments on commit 89c60de

Please sign in to comment.