diff --git a/README.md b/README.md index a739f9624..a8fdace42 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,51 @@ -# Twine +# Twine - RSS Reader ![CI-MAIN](https://github.com/msasikanth/twine/actions/workflows/ci_checks.yml/badge.svg?branch=main) ![banner](./readme_images/banner.png) +Twine is a multiplatform RSS reader app built using Kotlin and Compose Multiplatform. It features an nice +user interface and experience to browse through the feeds, and supports Material 3 content based +[dynamic theming](https://m3.material.io/styles/color/dynamic-color/user-generated-color). + ## Download Get it on Google Play Download on the App Store -### Requirements +## Features ✨ -- Android: 8.0+ -- iOS: 15.0+ +- Supports RSS & Atom feeds +- Bookmarks +- Search +- Pinned feeds +- Background sync -## Libraries +## Tech Stack 📚 -- [Kotlin Mutliplatform](https://kotlinlang.org/lp/multiplatform/) +- [Kotlin Multiplatform](https://kotlinlang.org/lp/multiplatform/) +- [Kotlin Coroutines](https://github.com/Kotlin/kotlinx.coroutines) - [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/) -- [Ktor Client](https://ktor.io/) +- [Ktor](https://ktor.io/) - [SQLDelight](https://cashapp.github.io/sqldelight/2.0.0-alpha05/) - [Decompose](https://arkivanov.github.io/Decompose/) - [Kotlin-inject](https://github.com/evant/kotlin-inject) -For full list of dependencies used, please take a look at the [catalog](/gradle/libs.versions.toml) file +For full list of dependencies used, please take a look at the [catalog](/gradle/libs.versions.toml) file. + +## Development 🛠️ + +You can just clone the repo and build it locally without requiring any changes. + +Project requires JDK 17+, and based on the AGP version defined in [`libs.versions.toml`](/gradle/libs.versions.tom) file, +you can use appropriate Android Studio to import the project. + +## Contributing ❤️ -## TODO +You can contribute bug fixes to the project via PRs, for anything else open an issue to start a conversation. -- [x] Add Atom feeds support -- [x] Background sync -- [x] Bookmarks -- [x] Search -- [x] ~~Rearrange~~ Pinned feeds -- [x] Rename feed +This project uses ktfmt, provided via the spotless gradle plugin, and the bundled project IntelliJ codestyle. Run +`./gradlew spotlessApply` to format the code before raising a PR. ## Made by