Skip to content

Commit

Permalink
bring back the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BrightDV committed Aug 30, 2022
1 parent 6e4dc43 commit ac6e17d
Showing 1 changed file with 52 additions and 4 deletions.
56 changes: 52 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,55 @@
# Box Box
<p align="center"><a href="https://newpipe.net"><img src="assets/images/icon.png" width="150"></a></p>
<h2 align="center"><b>Box, Box!</b></h2>
<h4 align="center">A new way to follow Formula 1.</h4>

An app for Formula 1 lovers!

## Contribute
## Screenshots

PRs are always welcome ;), feel free to ask questions!
[<img src="https://user-images.githubusercontent.com/92821484/175258967-7f6fb601-d721-453a-a2a9-b50b4b9d32b6.png" width=235>](https://user-images.githubusercontent.com/92821484/175258967-7f6fb601-d721-453a-a2a9-b50b4b9d32b6.png)
[<img src="https://user-images.githubusercontent.com/92821484/175259064-e1f25066-d742-4621-946e-5a321c418383.png" width=235>](https://user-images.githubusercontent.com/92821484/175259064-e1f25066-d742-4621-946e-5a321c418383.png)
[<img src="https://user-images.githubusercontent.com/92821484/175259015-f90daefb-0543-4776-8a02-c56fc6cb9493.png" width=235>](https://user-images.githubusercontent.com/92821484/175259015-f90daefb-0543-4776-8a02-c56fc6cb9493.png)
[<img src="https://user-images.githubusercontent.com/92821484/175259027-49fe393f-84eb-4d59-b939-b70c79721783.png" width=235>](https://user-images.githubusercontent.com/92821484/175259027-49fe393f-84eb-4d59-b939-b70c79721783.png)
[<img src="https://user-images.githubusercontent.com/92821484/175259052-acba24ce-bf7e-4650-b2cc-be0c0cbc1609.png" width=235>](https://user-images.githubusercontent.com/92821484/175259052-acba24ce-bf7e-4650-b2cc-be0c0cbc1609.png)
[<img src="https://user-images.githubusercontent.com/92821484/175259098-dac4ea80-394d-41a3-9bd7-62240ad10bba.png" width=235>](https://user-images.githubusercontent.com/92821484/175259098-dac4ea80-394d-41a3-9bd7-62240ad10bba.png)
[<img src="https://user-images.githubusercontent.com/92821484/175260688-5a3ff97d-35d3-4a69-aa89-9faf188e6e76.png" width=235>](https://user-images.githubusercontent.com/92821484/175260688-5a3ff97d-35d3-4a69-aa89-9faf188e6e76.png)

## Features

- Box, Box! is free software, under GPL v3 lincense.
- It contains no ads, no trackers or anything else.
- Get the latest stories of your favorite driver & his ranking, event without any Internet connection*.
- In-app reader for all the editorial articles with markdown!
- Enjoy the app event the night with its dark mode.
- Link to the highlights on YouTube of the qualifications and the race.
- Wait 'till the next race with its countdown

*You need to have Internet connection in order to refresh the data.

See the live demo [here.](https://brightdv.github.io)

## Services
| Screen | Service | Base URL |
| :---------------: |:---------------:| :---------------:|
| Home News | Formula 1 API | https://api.formula1.com |
| Standings | Ergast API | https://ergast.com/mrd |
| Schedule | Ergast API | https://ergast.com/mrd |
| Live Timing (coming soon...) | Formula 1 Live Timing | https://livetiming.formula1.com/ |

## Translation
For the moment, the app is only available in french, but it will be available in the next weeks.

## License
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)

```
Box, Box! is Free Software: You can use, study, share, and improve it at
will. Specifically you can redistribute and/or modify it under the terms of the
[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
```

## Note
I'm doing this app in my spare time, so I will appreciate the feedbacks and the PRs, but I can't do everyting ;).

Box, Box! is unofficial software and in no way associated with the Formula 1 group of companies.

0 comments on commit ac6e17d

Please sign in to comment.