diff --git a/README.md b/README.md index df95f6f..eeec796 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,50 @@ -# flo +
+ flo +

+

Meet flo, an open source Navidrome client written in Swift.

+
+# flo + +As mentioned many times, flo is an open source Navidrome client written in Swift. It has modern yet familiar user interfaces +built on top of Apple's latest UI framework: SwiftUI. While Navidrome supports Subsonic APIs, flo was purposely designed for Navidrome servers. + +However, flo is still under heavy development. Bugs and regular updates are expected to improve flo over time. It's worth noting that flo at +this stage is unlikely to harm your iPhone or your beloved Navidrome server. + +## Features + +Everything you can expect from a music player: it plays music. However, here are some features you may enjoy: + +- Online streaming (save your storage) +- Offline streaming (save your bandwidth) +- Play by album (shuffle for surprises) +- Background playback (just don't close the app) +- Control playback via the "command center" (something in your "notification") + +flo may have opt-in "social" features in the future to make the listening experience more fun and extroverted. But for now, flo is intended to become one of the best +Navidrome clients in the Apple ecosystem! + +To learn more about flo, visit flo's [landing page.](https://client.flooo.club) + +## Development + +For now just clone it and figure it out :) + +Jokes aside, make sure you have Xcode installed. The latest stable version is recommended, and as of this writing, Swift 5 is used. Another step, such as setting up a "provisioning profile," may be required to run this app in a development environment. + +This project uses integrated SwiftPM (Swift Package Manager) to manage app dependencies. So far, only two package are being used: + +- Alamofire — everyone's favorite http library +- KeychainAccess — a simple wrapper for Keychain access + +The minimum number of dependencies is intended to make the project easier to maintain. + +## Support + +Bug reports, typos, errors and feedback are welcome! Please use GitHub Issues for reports and GitHub Discussions for... discussion. For anything private, +you can reach me via email at oss [at] rizaldy.club. I don't check email often but I have push notifications turned on! + +## License + +MIT. diff --git a/meta/guthib.jpeg b/meta/guthib.jpeg new file mode 100644 index 0000000..ccb1db6 Binary files /dev/null and b/meta/guthib.jpeg differ