From 89c60dea3a762b3e4feaf44dc21de240ef24570f Mon Sep 17 00:00:00 2001
From: Tom Theret <tomnils.theret@gmail.com>
Date: Sat, 11 May 2024 00:32:12 +0200
Subject: [PATCH] update(readme): add roadmap

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++----
 1 file changed, 39 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 228ad0e..473ace3 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,35 @@ 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
@@ -17,19 +46,25 @@ 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