kbe/crossfit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: add licence and fix doc

Browse Source
This commit is contained in:
kbe
2025-07-20 20:15:28 +02:00
parent 2a2c5d889c
commit a67c9face3
2 changed files with 22 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 Kevin BATAILLE
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

20
README.md
View File

@@ -30,20 +30,6 @@ docker-compose up --build
The application will automatically check for available sessions and book them based on your preferences. It will send notifications via email and Telegram when a booking is successful. The application will automatically check for available sessions and book them based on your preferences. It will send notifications via email and Telegram when a booking is successful.
### Configuring Preferred Sessions
You can configure your preferred sessions using the `preferred_sessions.json` file. This file should contain a JSON array of session names, for example:
```json
[
"Morning Class",
"Evening Class",
"Saturday Open Gym"
]
```
If the file is not found or contains invalid data, the application will use default hardcoded sessions.
### Environment Variables ### Environment Variables
The following environment variables are required: The following environment variables are required:
@@ -82,7 +68,7 @@ You can configure your preferred sessions in the `preferred_sessions.json` file.
The application will automatically load the preferred sessions from this file. If the file is not found or contains invalid data, it will fall back to the default hardcoded sessions. The application will automatically load the preferred sessions from this file. If the file is not found or contains invalid data, it will fall back to the default hardcoded sessions.
#### Fields ### Fields
- `day_of_week`: Integer representing the day of the week (0=Monday, 6=Sunday) - `day_of_week`: Integer representing the day of the week (0=Monday, 6=Sunday)
- `start_time`: String representing the start time in HH:MM format - `start_time`: String representing the start time in HH:MM format
@@ -119,10 +105,6 @@ The application will automatically load the preferred sessions from this file. I
└── crossfit_booking.log └── crossfit_booking.log
``` ```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License ## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.