Merge pull request #17 from o0nd7ots/patch-1

Improving readme
This commit is contained in:
Xilin Jia 2024-03-22 11:44:24 +00:00 committed by GitHub
commit 14a79cd767
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 21 additions and 14 deletions

View File

@ -1,14 +1,25 @@
# Podcini
<img width="100" src="https://raw.githubusercontent.com/xilinjia/podcini/main/images/icon 256x256.png" align="left" style="margin-right:15px"/>Podcini is an open source podcast manager/player project.
<img width="100" src="https://raw.githubusercontent.com/xilinjia/podcini/main/images/icon 256x256.png" align="left" style="margin-right:15px"/>
Podcini is an open source podcast manager/player project.
This is based on a fork from the popular project AntennaPod (<https://github.com/AntennaPod/AntennaPod>) as of Feb 5 2024.
This app is a fork of [AntennaPod](<https://github.com/AntennaPod/AntennaPod>) as of Feb 5 2024.
Differing from the forked project, this project is purely Kotlin based, relies on the most recent dependencies, and most importantly has migrated the media player to androidx.media3, and added mechanism of AudioOffloadMode which is supposed to be kind to device battery. Efficiencies are also sought on running the app. App build is also upgraded to target Android 14.
Compared to AntennaPod this project:
1. Migrated the media player to `androidx.media3`,
2. Added `AudioOffloadMode` support, which is supposed to be kind to device battery,
3. Relies on the most recent dependencies,
4. Is __purely__ Kotlin based,
4. Targets Android 14,
5. Aims to be as effective as possible. <!-- NOTE: wording of this can be improved -->
## Version 4
Some drastic changes are made in the project since version 4.0. There is now a whole new interface of the Subscriptions page showing only the feeds with tags as filters, no longer having tags as folders in the page. And the default page of the app is changed to the Subscriptions page. Alongside, the Home and Echo pages are removed from the project. Also, the project becomes mono-module, with only the app module.
Some drastic changes are made in the project since version 4.0.
There is now a whole new interface of the Subscriptions page showing only the feeds with tags as filters, no longer having tags as folders in the page.
And the default page of the app is changed to the Subscriptions page.
Alongside, the Home and Echo pages are removed from the project.
Also, the project becomes mono-module, with only the app module.
Version 4.1 brings a more convenient player control and tags enhancements, while also enables view binding for most views in the codebase.
@ -24,24 +35,20 @@ Version 4.1 brings a more convenient player control and tags enhancements, while
<img src="./images/9_swipe_setting.jpg" width="238" /> <img src="./images/9_swipe_setting1.jpg" width="238" /> <img src="./images/91_feed_search.jpg" width="238" />
## Changelogs
[Here](changelog.md)
## Links
## Privacy Policy
[Privacy Policy](PrivacyPolicy.md)
- [Changelog](changelog.md)
- [Privacy Policy](PrivacyPolicy.md)
- [Translation (Transifex)](https://app.transifex.com/xilinjia/podcini/dashboard/)
## License
Podcini, same as its forked project AntennaPod, is licensed under the GNU General Public License (GPL-3.0). You can find the license text in the LICENSE file.
Podcini, same as its forked project AntennaPod, is licensed under the GNU General Public License (GPL-3.0).
You can find the license text in the LICENSE file.
## Copyright
New files and modifications in the project is copyrighted in 2024 by Xilin Jia.
Original contents from the forked project maintains copyrights of the AntennaPod team.
## Translation
[At Transifex](https://app.transifex.com/xilinjia/podcini/dashboard/)