Create README.md

This commit is contained in:
Haoyuan Liu 2020-06-09 14:39:31 +08:00 committed by GitHub
parent 5f759c5a9e
commit 0128728889
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

39
README.md Normal file
View File

@ -0,0 +1,39 @@
<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</h3>
<p align="center">A simplistic, modern desktop RSS reader</p>
<hr />
## Development
### Build from source
```bash
# Install dependencies
npm install
# Compile ts & dependencies
npm run build
# Start the application
npm run electron
# Package the app for Windows
npm run package-win
# Generate certificate and sign the appx package
electron-builder create-self-signed-cert
signtool sign /fd SHA256 /a /f XXX.pfx "Fluent Reader X.X.X.appx"
```
### Developed with
- [Electron](https://github.com/electron/electron)
- [React](https://github.com/facebook/react)
- [Redux](https://github.com/reduxjs/redux)
- [Fluent UI](https://github.com/microsoft/fluentui)
- [NeDB](https://github.com/louischatriot/nedb)
### License
BSD