~cytrogen/fluent-reader-mobile

0e14fd58517e232bdbf350eb0b4f8b18b6c22153 — Haoyuan Liu 5 years ago 4a21d32
Update README.md
1 files changed, 57 insertions(+), 10 deletions(-)

M README.md
M README.md => README.md +57 -10
@@ 1,16 1,63 @@
# fluent_reader_lite
<p align="center">
  <img width="120" height="120" src="https://github.com/yang991178/rss-reader/raw/master/build/icon.png">
</p>
<h3 align="center">Fluent Reader Lite</h3>
<p align="center">A simplistic mobile RSS client</p>
<hr />

A new Flutter project.
## Download

## Getting Started
Fluent Reader Lite will first be available through TestFlight on iOS and as an APK download through GitHub Releases on Android. 
Eventually, the app will be released on App Store and Google Play Store.

This project is a starting point for a Flutter application.
## Features

A few resources to get you started if this is your first Flutter project:
Fluent Reader Lite is a simplistic, cross-platform, and open-source RSS client.

- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)
The following self-hosted or commercial RSS services are supported.

For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
- Fever API (TT-RSS Fever plugin, Fresh RSS, Miniflux, etc.)
- Google Reader API (Bazqux Reader, The Old Reader, etc.)
- Inoreader
- Feedbin (official or self-hosted)

Other key features include:

- Dark mode for UI and reading.
- Configure sources to load full content or webpage by default.
- A dedicated subscriptions tab organized by latest updates with article titles.
- Search for local articles or filter by read status.
- Organize subscriptions with groups.
- Support for two-pane view on iPad and Android tablets.

The following features from the desktop app are **NOT** present:

- Local RSS support and source / group management.
- Importing or exporting OPML files, full application data backup & restoration.
- Regular expression rules that mark articles as they arrive.
- Fetch articles in the background and send push notifications.
- Keyboard shortcuts.

## Development

### Contribute

Help make Fluent Reader better by reporting bugs or opening feature requests through [GitHub issues](https://github.com/yang991178/fluent-reader-lite/issues). 

You can also help internationalize the app by providing [translations into additional languages](https://github.com/yang991178/fluent-reader-lite/tree/master/lib/l10n). 
You can read more about ARB files [here](https://localizely.com/flutter-arb) or [here](https://github.com/google/app-resource-bundle/wiki/ApplicationResourceBundleSpecification). 

If you enjoy using this app, consider supporting its development by donating through [Paypal](https://www.paypal.me/yang991178) or [Alipay](https://hyliu.me/fluent-reader/imgs/alipay.jpg).

### Build from source

See [Flutter documentation](https://flutter.dev/docs).

### Developed with

- [Flutter](https://github.com/flutter/flutter)
- [Mercury Parser](https://github.com/postlight/mercury-parser)

### License

BSD