From 2d52c622b4035b2f7d7031ca4e6c6b08959be216 Mon Sep 17 00:00:00 2001 From: Igor Kuzmenko Date: Fri, 28 Jul 2017 21:38:27 +0200 Subject: [PATCH] Updates wallets' management documentation This commit removes ordering instruction, as wallets are stored in individual files. Adds Level property description section to the "Adding a wallet" section. --- docs/managing-wallets.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/managing-wallets.md b/docs/managing-wallets.md index 95bd6e20..4c816bb5 100644 --- a/docs/managing-wallets.md +++ b/docs/managing-wallets.md @@ -87,14 +87,11 @@ to request an exemption or policy change. Feel free to email Will Binns ([will@bitcoin.org](mailto:will@bitcoin.org)) or Dave Harding ([dave@dtrt.org](mailto:dave@dtrt.org)) if you have any questions. -Wallets can be added in `_wallets/[wallet_name].md`. Entries are -ordered by levels and new wallets must be added after the last wallet on the -same level. +Wallets can be added by creating a Markdown file with a wallet name +in a `_wallets` folder, like this: `_wallets/[wallet_name].md`. -* Level 1 - Full nodes -* Level 2 - SPV, Random servers -* Level 3 - Hybrid, Multisig wallets -* Level 4 - Web wallets +For examples refer to the existing wallet files or check +`quality-assurance/schemas/wallets.yaml` schema. **Screenshot**: The png files must go in `/img/screenshots`, be 250 X 350 px and optimized with `optipng -o7 file.png`. @@ -106,6 +103,14 @@ or 85 X 85 px for square icons. **Description**: The text must go in `_translations/en.yml` alongside other wallets' descriptions. +**Level**: Each wallet must have a level property assigned. A value must be in a range +between 1 and 4. Level represents a category of a wallet: + +* Level 1 - Full nodes +* Level 2 - SPV, Random servers +* Level 3 - Hybrid, Multisig wallets +* Level 4 - Web wallets + ### Score Each wallet is assigned a score for five criteria. For each of them, the