turboself-api 1.2.7 → 2.0.1

package/LICENSE

@@ -632,7 +632,7 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) <year>  <name of author>
+    Copyright (C) 2024 Raphaël SCHRÖDER
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    <program>  Copyright (C) <year>  <name of author>
+    turboself-api  Copyright (C) 2024  Raphaël SCHRÖDER
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

package/README.md

@@ -5,71 +5,40 @@
 [![npm](https://img.shields.io/npm/dw/turboself-api)](https://www.npmjs.com/package/turboself-api)
 [![npm](https://img.shields.io/npm/dt/turboself-api)](https://www.npmjs.com/package/turboself-api)
 
-A simple wrapper to interact with the TurboSelf API.
+A powerful and user-friendly wrapper for interacting with the TurboSelf API.
 
 > [!warning]
 > This project is not affiliated with TurboSelf or INCB in any way.
 
-## 📝 Roadmap
-
-- [X] Authentification
-
-  - [x] With credentials
-  - [X] 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)
+## 🚀 What's New in v2.0
+- **Complete Code Refactoring**: Improved project structure for better maintainability and performance.
+- **New Endpoints**: Added new endpoints to provide more comprehensive coverage of TurboSelf API functionalities.
+- **Bug Fixes**: Corrected type errors that were due to missing documentation in version 1.0.
+- **Performance Enhancements**: Optimized code for faster response times and better overall performance.
 
 ## 📦 Installation
-
-```bash
+```
 npm install turboself-api
 ```
 
-## 🔧 Usage
-
-### Authentification with credentials
-
-```javascript
-const TurboSelf = require("turboself-api");
+## 📚 Exemple
+```ts
+import { authenticateWithCredentials } from "turboself-api";
 
 async function main() {
-  let client = await TurboSelf.authenticateWithCredentials({
-    username: "your_email",
-    password: "your_password",
-  });
-  console.log(client);
+  let client = await authenticateWithCredentials(
+    "your_email", 
+    "your_password"
+  )
+
+  console.log(client)
 }
 
 main();
 ```
 
-### Other exemples
-
-To see more examples, check the [examples](https://github.com/raphckrman/turboself-api/tree/dev/examples) folder.
-
-## ௷ Credits
-
+## 💡 Credits
 Thanks to the following people for their contributions to this project:
-
 - [Remy Godet](https://github.com/godetremy)
 - [Tom Theret](https://github.com/tom-theret)
+- [TouchGuild](https://github.com/DinographicPixels/TouchGuild/) for the ESLint rules