From 13326c84cbde032a6cba997f581194f20b03fbb1 Mon Sep 17 00:00:00 2001 From: Slesarew <33295157+Slesarew@users.noreply.github.com> Date: Mon, 25 Oct 2021 22:47:29 +0300 Subject: [PATCH] docs: temporary readme redirect (#851) * docs: temporary readme redirect Until we have proper documentation, people should be guided to old docs * docs: rewritten in clear terms Co-authored-by: Dan Shields <35669742+NukeManDan@users.noreply.github.com> * Update README.md * nuke - tweak README * docs: remove safety statements and mark the published release Co-authored-by: Dan Shields <35669742+NukeManDan@users.noreply.github.com> Co-authored-by: Dan Shields --- README.md | 79 +++++++++++++++++++------------------------------------ 1 file changed, 27 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index adfc9d9848..d5bf83bb89 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,46 @@ -![Parity Signer](https://wiki.parity.io/logo-parity-signer.jpg) +![Parity Signer](./docs/src/tutorials/images/logo-parity-signer.jpg) -[](https://github.com/paritytech/parity-signer/releases/) -[](https://play.google.com/store/apps/details?id=io.parity.signer) -[](https://itunes.apple.com/us/app/parity-signer/id1218174838) +
+ + + +
-# Parity Signer - Turn your smartphone into a hardware wallet +# Parity Signer -![Parity Signer](./tutorials/images/logo-parity-signer.jpg) +Parity Signer is a mobile application that allows any smartphone to act as an air-gapped crypto +wallet. This is also known as "cold storage". -**Please read instructions in [Getting started](#getting-started) before building or using the Signer** +You can create accounts in Substrate-based networks, sign messages/transactions, and transfer +funds to and from these accounts without any sort of connectivity enabled on the device. -Parity Signer is a mobile application that allows any smartphone to act as an air-gapped crypto wallet. This is also known as "cold storage". +You must turn off or even physically remove the smartphone's Wifi, Mobile Network, and Bluetooth +to ensure that the mobile phone containing these accounts will not be exposed to any online threat. +Switching to airplane mode suffices in many cases. -You can create accounts in Substrate-based networks, sign messages/transactions, and transfer funds to and from these accounts without any sort of connectivity enabled on the device. +========================================================== -You must turn off or even physically remove the smartphone's Wifi, Mobile Network, and Bluetooth to ensure that the mobile phone containing these accounts will not be exposed to any online threat. Switching to airplane mode suffices in many cases. +# !!! Parity Signer is being refactored from the ground up !!! -**Disabling the mobile phone's networking abilities is a requirement for the app to be used as intended, check our [wiki](./wiki/Security-And-Privacy.md) for more details.** +The legacy app is still **fully functional** and is published +on the app stores. The source and documentation in the `./docs` directory for these are +available in release branches (see below). -Have a look at the tutorial on our wiki to learn how to use [Parity Signer together with Polkadot-js app](./tutorials/Kusama-tutorial.md). +[The legacy documentation for the published app is here](https://github.com/paritytech/parity-signer/tree/legacy-4.6.2/docs) -Any data transfer from or to the app happens using QR code. By doing so, the most sensitive piece of information, the private keys, will never leave the phone. The Parity Signer mobile app can be used to store any Substrate account, this includes Polkadot (DOT) and Kusama (KSM) networks. +**NOTE: The `./docs` directory in this branch is under heavy development and is not updated for +the refactor at this time.** -## Key features - -- This is not a complete cryptowallet in itself. The Signer does not sync with blockchain, so it does not know your account balance, whether transactions were successful or even if the account exists! This is a **cold wallet** app only stores keys, reads and signs messages. It should always be used with **hot wallet** like [polkadot.js](https://polkadot.js.org/apps) -- The Signer alone does not make your accounts secure. **You must maintain security yourself**. Airgap should be only part of your security protocol, improper use of Signer could still lead to loss of funds and/or secrets. -- When properly used, Signer provides best achievable security with Substrate networks to-date. - -## System requirements - -Currently Signer is available only for iOS. Android version is coming soon. - -## Getting Started - -**These tutorials and docs are heavily outdated at the moment, please use them as references or help improving** - -If you are upgrading from older version of Signer, please see [changelog](./wiki/Changelog.md) and [upgrading Signer](./wiki/Upgrading.md) - -Please note that the Signer app is an advanced tool designed for maximum security and complex features. In many use cases, more user-friendly tools would be sufficient. - -[Getting started guide](./tutorials/Start.md) - -### Tutorials - -- [Signing with Pokadot.js Apps](./tutorials/Kusama-tutorial.md) -- [Recover Account from Polkadot.js Apps](./tutorials/Recover-Account-Polkadotjs.md) -- [Manage Accounts on Parity Signer](./tutorials/Hierarchical-Deterministic-Key-Derivation.md) -- [Update New Network](./tutorials/New-Network.md) - -### Wiki - -- [Security and Privacy](./wiki/Security-And-Privacy.md) -- [Development](./wiki/Development.md) -- [Building and Publishing](./wiki/Building-And-Publishing.md) -- [Testing](./wiki/Test.md) -- [Troubleshooting](./wiki/Troubleshooting.md) -- [QA Check List](./wiki/QA.md) -- [Key derivations](https://substrate.dev/docs/en/knowledgebase/integrate/subkey) -- [Changelog](./wiki/Changelog.md) -- [QR encoding definition](https://github.com/maciejhirsz/uos) +========================================================== ### Legacy versions -Older versions of this app could be useful for development, however, they are not safe for use in production. They are available at following branches: +Published version for use is available at following branch: - [Last public release with React Native](https://github.com/paritytech/parity-signer/tree/legacy-4.5.3) + +> Other unreleased development versions of this app could be useful for reference. + - [Non-ascii characters fix and some transaction parsing](https://github.com/paritytech/parity-signer/tree/legacy-4.6.2) - [Metadata types import and message parsing in RN](https://github.com/paritytech/parity-signer/tree/legacy-metadataRN) - [Rust backend with RN frontend](https://github.com/paritytech/parity-signer/tree/legacy-rust)