Merge branch 'feature/1.1-release'

RiseVision · Mar 11, 2019 · 1b4138a · 1b4138a
2 parents 6f3bb3d + 050bd51
commit 1b4138a
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -3,7 +3,15 @@
 [![Build Status](https://travis-ci.org/RiseVision/rise-react-wallet.svg?branch=master)](https://travis-ci.org/RiseVision/rise-react-wallet)
 [![Crowdin](https://d322cqt584bo4o.cloudfront.net/rise-web-wallet/localized.svg)](https://crowdin.com/project/rise-web-wallet)
 
-RISE Wallet - web & desktop wallet for the **RISE** DPoS blockchain. Build using **TypeScript**, **React** and **Material UI**.
+RISE Wallet - web & desktop wallet for the **RISE** DPoS blockchain. Built using **TypeScript**, **React** and **Material UI**.
+
+<p align="center">
+	<img src="docs/desktop.png" alt="Desktop screenshot">
+</p>
+<p align="center">
+	<img src="docs/mobile-1.png" alt="Mobile screenshot">
+	<img src="docs/mobile-2.png" alt="Mobile settings screenshot">
+</p>
 
 ### Web access
 
@@ -15,45 +23,58 @@ RISE Wallet - web & desktop wallet for the **RISE** DPoS blockchain. Build using
 - [Latest release](https://github.com/RiseVision/rise-react-wallet/releases/latest)
 - [Previous releases](https://github.com/RiseVision/rise-react-wallet/releases)
 
-### Status
+### Features
 
-- [x] Onboarding
-- [x] Account page
-- [x] Settings
-- [x] Sending Coins
-- [x] Delegates support
-- [x] Address book
+- [x] Sending & receiving RISE
+- [x] Voting for DPoS delegates
 - [x] Ledger hardware wallet support
-- [x] Unit tests
-- [x] End-to-end tests
+- [x] Offline support
+- [x] Address book
+- [x] Connecting to custom nodes
+- [x] Desktop versions
+- [x] Translations (ET, FR, NL, PL, [more to come](https://github.com/RiseVision/rise-react-wallet/blob/master/docs/managing-translations.md))
+
+### Install to Home Screen / Desktop
+
+RISE Wallet being a Progressive Web App (PWA) can be installed on a phone's 
+home screen (iOS, Android) or a desktop OS (currently only on Chrome win/linux).
+This will remove the browser's UI and combined with offline support will give 
+you a native-like experience (push notifications [still to come](https://github.com/RiseVision/rise-react-wallet/issues/186)).
 
 ### Nightly builds
 
 Automatic nightly builds are provided directly from `master`:
+
 - [gh-wallet.rise.vision](https://gh-wallet.rise.vision/)
 - [Windows](https://gh-wallet.rise.vision/rise-wallet-win-nightly.zip)
 - [Linux](https://gh-wallet.rise.vision/rise-wallet-linux-nightly.tar.gz)
 - [MacOS](https://gh-wallet.rise.vision/rise-wallet-macos-nightly.tar.gz)
 
 ### Contributing
 
-Running:
-1. Clone the repo
-1. Run `yarn start`
+Dev build (live reload):
 
-Building:
-1. Clone the repo
-1. Run `yarn build`
+1.  Clone the repo
+1.  Run `yarn start`
+
+Production build:
+
+1.  Clone the repo
+1.  Run `yarn build; yarn serve`
+
+Translations:
+
+- You can help with [translating the wallet](https://github.com/RiseVision/rise-react-wallet/blob/master/docs/managing-translations.md)
 
 ### Custom backend
 
 To get the wallet working with a custom RISE deployment by default:
-1. Checkout a working copy
-1. Edit `src/config.json` and change both `api_url` and `api_url_testnet`
-1. Build a release with `yarn build` or `yarn run release`
 
-Keep in mind that you can simply use Node Switcher to connect to your node manually.
+1.  Checkout a working copy
+1.  Edit `src/config.json` and change both `api_url` and `api_url_testnet`
+1.  Build a release with `yarn build` or `yarn release`
 
+Keep in mind that you can simply use Node Switcher to connect to your node manually.
 
 ### About RISE
 

diff --git a/docs/desktop.png b/docs/desktop.png
diff --git a/docs/mobile-1.png b/docs/mobile-1.png
diff --git a/docs/mobile-2.png b/docs/mobile-2.png