Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img width="120" height="120" src="https://github.com/yang991178/fluent-reader/raw/master/build/icon.png">
<img width="120" height="120" src="https://github.com/HaleShaw/fluent-reader/raw/master/build/icon.png">
</p>
<h3 align="center">Fluent Reader</h3>
<p align="center">A modern desktop RSS reader</p>
Expand All @@ -12,11 +12,11 @@

## Download

For Windows 10 users, the recommended way of installation is through [Microsoft Store](https://www.microsoft.com/store/apps/9P71FC94LRH8?cid=github).
This enables auto-update and experimental ARM64 support.
For Windows 10 users, the recommended way of installation is through [Microsoft Store](https://www.microsoft.com/store/apps/9P71FC94LRH8?cid=github).
This enables auto-update and experimental ARM64 support.
macOS users can also get Fluent Reader from the [Mac App Store](https://apps.apple.com/app/id1520907427).

If you are using Linux or an older version of Windows, you can [get Fluent Reader from GitHub releases](https://github.com/yang991178/fluent-reader/releases).
If you are using Linux or an older version of Windows, you can [get Fluent Reader from GitHub releases](https://github.com/HaleShaw/fluent-reader/releases).

### Mobile App

Expand All @@ -25,7 +25,7 @@ The repo of the mobile version of this app [can be found here](https://github.co
## Features

<p align="center">
<img src="https://github.com/yang991178/fluent-reader/raw/master/docs/imgs/screenshot.jpg">
<img src="https://github.com/HaleShaw/fluent-reader/raw/master/docs/imgs/screenshot.jpg">
</p>

- A modern UI inspired by Fluent Design System with full dark mode support.
Expand All @@ -35,24 +35,25 @@ The repo of the mobile version of this app [can be found here](https://github.co
- Read the full content with the built-in article view or load webpages by default.
- Search for articles with regular expressions or filter by read status.
- Organize your subscriptions with folder-like groupings.
- Single-key [keyboard shortcuts](https://github.com/yang991178/fluent-reader/wiki/Support#keyboard-shortcuts).
- Single-key [keyboard shortcuts](https://github.com/HaleShaw/fluent-reader/wiki/Support#keyboard-shortcuts).
- Hide, mark as read, or star articles automatically as they arrive with regular expression rules.
- Fetch articles in the background and send push notifications.

Support for other RSS services are [under fundraising](https://github.com/yang991178/fluent-reader/issues/23).
Support for other RSS services are [under fundraising](https://github.com/yang991178/fluent-reader/issues/23).

## Development

### Contribute

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

You can also help internationalize the app by providing [translations into additional languages](https://github.com/yang991178/fluent-reader/tree/master/src/scripts/i18n).
Refer to the repo of [react-intl-universal](https://github.com/alibaba/react-intl-universal) to get started on internationalization.
You can also help internationalize the app by providing [translations into additional languages](https://github.com/HaleShaw/fluent-reader/tree/master/src/scripts/i18n).
Refer to the repo of [react-intl-universal](https://github.com/alibaba/react-intl-universal) to get started on internationalization.

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

### Build from source

```bash
# Install dependencies
npm install
Expand All @@ -65,9 +66,13 @@ npm run electron

# Generate certificate for signature
electron-builder create-self-signed-cert
# Package the app for Windows

# Package the app for Windows: x64, x32, arm64
npm run package-win

# Package the app for Windows x64
npm run package-win-x64

```

### Developed with
Expand Down
Loading