From a649b0bb6998d1e03859a4cfaa3dda60a62114a2 Mon Sep 17 00:00:00 2001 From: Adrian Baumgart Date: Sat, 21 Oct 2023 20:50:52 +0200 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 58de6af..297d3fe 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,18 @@ +
+ + Shlink Manager logo + # Shlink Manager -This is a mobile app for Android to see and manage all shortened URLs created with [Shlink](https://shlink.io/). +
-## Current Features +Shlink Manager is an app for Android to see and manage all shortened URLs created with [Shlink](https://shlink.io/) + + +Play Store download + + +## 📱 Current Features ✅ List all short URLs
✅ Create new short URLs
@@ -13,7 +23,7 @@ This is a mobile app for Android to see and manage all shortened URLs created wi ✅ Display QR code
✅ Dark mode support
-## To Do +## 🔨 To Do - [ ] Edit existing short URLs - [ ] Add support for iOS (maybe in the future) - [ ] add tags @@ -21,6 +31,17 @@ This is a mobile app for Android to see and manage all shortened URLs created wi - [ ] improve app icon - [ ] ...and more -## License +# 💻 Development -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details \ No newline at end of file +First make sure you've installed [Flutter](https://flutter.dev/) and the necessary tools to build for Android/iOS (Android Studio/Xcode). + +```bash +$ git clone https://github.com/rainloreley/shlink-manager.git +$ cd shlink-manager +$ flutter pub get +$ flutter run +``` + +##📄 License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details