Skip to content

Latest commit

 

History

History
99 lines (72 loc) · 4.37 KB

README.md

File metadata and controls

99 lines (72 loc) · 4.37 KB

Twine - RSS Reader

CI-MAIN Sponsor

banner

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.

Download

Get it on Google Play Download on the App Store

Screenshots

Home Screen Home Screen Scrolled Feeds Sheet Add Feed Edit Feeds Search Screen Bookmarks Screen Settings Screen Reader Screen

Features ✨

  • Supports RSS & Atom feeds
  • Feed management: Add, Edit & Pin feeds
  • Feed grouping
  • Access to pinned feeds/groups from bottom bar
  • Smart fetching: Twine looks for feeds when given any website homepage
  • Article shortcut to fetch full article in reader view
  • Bookmark posts to read later
  • Search posts
  • Background sync
  • Import and exports your feeds with OPML
  • Dynamic content theming
  • Light/Dark mode support

Tech Stack 📚

For full list of dependencies used, please take a look at the catalog file.

Development 🛠️

You can just clone the repo and build it locally without requiring any changes.

Project requires JDK 20+, and based on the AGP version defined in libs.versions.toml file, you can use appropriate Android Studio to import the project.

Contributing 🛠️

You can contribute bug fixes to the project via PRs, for anything else open an issue to start a conversation.

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 ❤️

Error Reporting by

bugsnag logo

License

Copyright Sasikanth Miriyampalli

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.