Updated Readme

Signed-off-by: Balazs Toldi <balazs@toldi.eu>
This commit is contained in:
Balazs Toldi 2023-07-21 19:15:50 +02:00
parent f6800b818d
commit 09d8d17278
No known key found for this signature in database
GPG Key ID: 6C7D440036F99D58

111
README.md
View File

@ -1,11 +1,10 @@
<h1 align="center">
LemmInfinity (Infinity For Lemmy) <a href="https://www.patreon.com/docile_alligator"><img src="https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white" alt="Patreon"></a>
</h1>
<div align="center">
A Lemmy client on Android written in Java. It does not have any ads and it features a clean UI and smooth browsing experience
A Lemmy client on Android written in Java. It's a fork of the [Infinity for Reddit](https://github.com/Docile-Alligator/Infinity-For-Reddit) project, currenty in early development.
<img align="right" src="https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/raw/branch/master/fastlane/metadata/android/en-US/images/LemmInfinity.png" width=200>
@ -16,15 +15,9 @@ A Lemmy client on Android written in Java. It does not have any ads and it featu
<div align="center">
<br>
<a href="https://github.com/Docile-Alligator/Infinity-For-Reddit/wiki"><strong>Explore the docs »</strong></a>
<br>
<a href="https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/issues">Report a Bug</a>
·
<a href="https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/issues">Request a Feature</a>
·
<a href="https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/issues">Ask a Question</a>
</div>
@ -35,39 +28,13 @@ A Lemmy client on Android written in Java. It does not have any ads and it featu
</div>
## Donation
<p>Infinity for Reddit+:</p>
<a href="https://play.google.com/store/apps/details?id=eu.toldi.infinityforlemmy.plus">
<img alt="Get it on Google Play" height="80" src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" />
</a>
Patreon: https://www.patreon.com/docile_alligator
Bitcoin: bc1qxtkd5ap9na7uy8nr9qpt6jny6tdwaj4v43ddle
<details>
<summary>Table of Contents</summary>
- [About](#about)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Usage](#usage)
- [Cookiecutter template](#cookiecutter-template)
- [Manual setup](#manual-setup)
- [Variables reference](#variables-reference)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [Support](#support)
- [License](#license)
- [Acknowledgements](#acknowledgements)
</details>
---
## Action Items for LemmInfinity
LemmInfinity is currently in the early stages of development. Expect many unfinished features and bugs!
- [x] Implementation of basic post browsing feature
- [x] Support for multiple account handling
- [x] Functionality for post upvotes/downvotes
@ -80,63 +47,6 @@ Bitcoin: bc1qxtkd5ap9na7uy8nr9qpt6jny6tdwaj4v43ddle
- [ ] Account editing function
- [ ] Multi community view?
## About The Project
<table>
<tr>
<td>
Key features of **Infinity For Reddit**:
- Lazy mode: Automatic scrolling of posts enables you to enjoy amazing posts without moving your thumb.
- Browsing posts
- View comments
- Expand and collapse comments section
- Vote posts and comments
- Save posts
- Write comments
- Edit comments and delete comments
- Submit posts (text, link, image and video)
- Edit posts (mark and unmark NSFW and spoiler and edit flair) and delete posts
- See all the subscribed subreddits and followed users
- View the messages
- Get notifications of unread messages
- etc...
</td>
</tr>
</table>
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png"
alt="Screenshot 1"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png"
alt="Screenshot 2"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/3.png"
alt="Screenshot 3"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/4.png"
alt="Screenshot 4"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/5.png"
alt="Screenshot 5"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/6.png"
alt="Screenshot 6"
height="200" >
<img
src="https://raw.githubusercontent.com/Wladefant/Infinity-For-Reddit/master/fastlane/metadata/android/en-US/images/phoneScreenshots/7.png"
alt="Screenshot 7"
height="200" >
<p align="right">(<a href="#top">back to top</a>)</p>
## Contributing
@ -155,25 +65,22 @@ Don't forget to give the project a star! Thanks again!
Here are other ways you can help:
- [Report Bugs](https://github.com/Docile-Alligator/Infinity-For-Reddit/issues)
- [Make Suggestions](https://github.com/Docile-Alligator/Infinity-For-Reddit/discussions)
- [Translate The App](https://poeditor.com/join/project?hash=b2IRyfaJv6)
- [Report Bugs](https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/issues)
<p align="right">(<a href="#top">back to top</a>)</p>
## License
Distributed under the AGPL-3.0 License. See <a href="https://github.com/Docile-Alligator/Infinity-For-Reddit/blob/master/LICENSE">LICENSE</a> for more information.
Distributed under the AGPL-3.0 License. See <a href="https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy/src/branch/master/LICENSE">LICENSE</a> for more information.
<p align="right">(<a href="#top">back to top</a>)</p>
## Contact
[u/Hostilenemy](https://www.reddit.com/user/Hostilenemy) -
docilealligator.app@gmail.com (Owner)
[@bazsalanszky@lemmy.toldi.eu](https://lemmy.toldi.eu/u/bazsalanszky) - (Owner)
or [u/Wladefant](https://www.reddit.com/user/Wladefant) - wladefant@gmail.com (Collaborator)
Project Link: [https://github.com/Docile-Alligator/Infinity-For-Reddit](https://github.com/Docile-Alligator/Infinity-For-Reddit)
Project Link: [https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy](https://codeberg.org/Bazsalanszky/Infinity-For-Lemmy)
<p align="right">(<a href="#top">back to top</a>)</p>