Renshuu Widget for Android

Welcome to the Renshuu Widget for Android repository! This project is an open-source Android application that leverages the Renshuu API to populate a widget that shows your Renshuu mastery schedules directly on your home screen.

Table of Contents

• Features
• Installation
• Usage
• Contributing
• License
• Credits
• Contact

Features

• Interactive Widget: Displays your mastery schedules and open the Renshuu official application on click.
• Automatic Updates: The widget updates automatically every 15 minutes and when you open the companion app.
• Lightweight and Fast: Designed to be efficient and easy to use without draining battery life.

Installation

Prerequisites

• An Android device running Android 7.0 or higher.
• A Renshuu API Key (You can obtain this from your Renshuu account settings).

From source

1. Clone the repository:

   git clone https://github.com/yourusername/renshuu-widget-android.git
   cd renshuu-widget-android

2. Open the project in Android Studio:

   • Open Android Studio and select "Open an existing Android Studio project".
   • Navigate to the renshuu-widget-android directory and select it.

3. Build and Run:

   • Connect your Android device or use an emulator.
   • Click "Run" in Android Studio to install the app on your device.

From the play store

Navigate to the play store page and install it!

Usage

1. Add the Widget:

   • Long press on your home screen and select "Widgets".
   • Find the "Renshuu Widget" in the list and drag it to your home screen.

2. Configure the Widget:

   • Tap the app icon to open it. Note that if you press the widget to open the Renshuu app, pressing the Widget app icon may lead you to the Renshuu app instead. In this case, you need to kill both apps and re-open the widget app.
   • Enter your Renshuu API key and press save.
   • The widget will update automatically.
   • If you have troubles with the widget updates, follow the instruction in the app to remove it from battery optimizations.

3. Enjoy!:

   • Your widget will now show your mastery schedules! Tap any of them to open the app.

Contributing

Contributions are welcome! If you have any ideas or improvements, please feel free to fork the repository and submit a pull request. You can also open an issue if you find any bugs or have feature requests.

How to Contribute

1. Fork the project.
2. Create your feature branch: git checkout -b feature/AmazingFeature.
3. Commit your changes: git commit -m 'Add some AmazingFeature'.
4. Push to the branch: git push origin feature/AmazingFeature.
5. Open a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

• Renshuu API: This app utilizes the Renshuu API for fetching data. Special thanks to the Renshuu team for providing such a great resource for learning Japanese.
• Community Contributions: A big thank you to all the contributors who help improve this project.

Contact

For any questions, suggestions, or feedback, feel free to reach out via:

• Email: emmanuele.villa89@gmail.com
• GitHub Issues: GitHub Issues