lgallet/velib-tracker
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: 📝 Create the README file

Browse Source
This commit is contained in:
Louis Gallet 2023-09-02 22:26:54 +02:00
parent 80fdaaad35
commit 5208ecea65
Signed by: lgallet
SSH Key Fingerprint: SHA256:qnW7pk4EoMRR0UftZLZQKSMUImbEFsiruLC7jbCHJAY
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -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.