diff --git a/README.md b/README.md new file mode 100644 index 0000000..6d43ba3 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +

+ +

+ +# YAM Launcher + +YAM Launcher is a minimalist text-based launcher for Android with weather integration. + +Key features: +- No flashy effects, icons or other distractions. Perfect for digital minimalism. +- Customizable shortcuts for your most used apps. +- Weather integration with [Open-Meteo](https://open-meteo.com/). (optional) +- Work profile support. +- Search on the bottom of the screen. +- System fonts for an uniform look with your Android. +- Simple by default, customizable under the hood. +- Open-source under the MIT License. + +## Installation + +### F-Droid + +Coming soon... + +### Google Play + +Coming soon... + +### APK + +Coming soon... + +## Bugs, feature requests, etc + +Submit an issue on the *Issues* tab. + +## Contributing + +### Development + +Feel free to contribute code improvements and bug fixes. For big changes, I would recommend creating an issue first so that I can figure out whether I want the change to be implemented. Generally I am open to optional features that can be enabled or disabled in the preferences as long as they are not too convoluted, but no guarantees. + +### Donations + +If you wish to support me and my work financially, I welcome all donations. These help me feed myself and get any equipment I may need for future development (Wouldn't it be cool to run my own instance of Open-Meteo instead of using the public one?). + +One-time donations: [Stripe](https://donate.stripe.com/14k6s2bMJdnDgtW288) + +Recurring donations: [Liberapay](https://liberapay.com/ottoptj/donate) \ No newline at end of file