From 5208ecea6598580a64bd5a08e8c797c5b044025f Mon Sep 17 00:00:00 2001 From: Louis Date: Sat, 2 Sep 2023 22:26:54 +0200 Subject: [PATCH] docs: :pencil: Create the README file --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index a2d5c70..484a0ed 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ # Velib tracker app +An application to track the number of Velibs currently available in nearby stations + + +## Disclaimer +This application is in no way affiliated to Smoovengo. It uses the City of Paris' public API to provide the various results. The application is also under development and serves more as a side-project for learning Swift. + +## Features +- [x] Display the number of Velibs available in nearby stations +- [ ] Display the number of Velibs available in a specific station +- [ ] Display the number of Velibs available in a specific station on a map +- [ ] Search for a particular station + +## Requirements +- iOS 15.0+ +- Xcode 13.0+ +- Swift 5.0+ + +## Installation +1. Clone the repository +2. Open the project in Xcode +3. Build and run the project + +## Install on your device +The application is available from TestFlight via this link. If you have an Apple Developer account, you can install it directly on your devices by following the instructions above.