diff --git a/README.md b/README.md new file mode 100644 index 0000000..7158c00 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +

+ +

+

Fluent Reader

+

A simplistic, modern desktop RSS reader

+
+ +## 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