From 2b0604077d74d8352acdccf2f76abe009e2dc6f7 Mon Sep 17 00:00:00 2001
From: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
Date: Thu, 21 May 2020 06:17:29 +0200
Subject: [PATCH] Update README.md (#121)

* Update README.md

* Update wordlist.txt
---
 README.md    | 21 +++++++++++++++++++++
 wordlist.txt | 14 ++++++++------
 2 files changed, 29 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 98c707c..489d961 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,27 @@ its various capabilities.
 
 If you need help, ask in #protocol at Status / Discord.
 
+### Spellcheck
+
+To run the spellchecker locally, you must install [pyspelling](https://facelessuser.github.io/pyspelling/).
+
+It can then be run with the following command:
+
+```console
+pyspelling -c spellcheck.yml
+```
+
+Words that should be ignored or are unrecognized must be added to the [wordlist](./wordlist.txt).
+
+### Markdown Verification
+
+We use [remark](https://remark.js.org/) to verify our markdown. You can easily run this tool simply by using our `npm` package:
+
+```console
+npm install
+npm run lint
+```
+
 ## Spec lifecycle
 
 Every spec has its own lifecycle that shows its maturity. We indicate this in a similar fashion to [COSS Lifecycle](https://rfc.unprotocols.org/spec:2/COSS/):
diff --git a/wordlist.txt b/wordlist.txt
index dd717d7..acfdaff 100644
--- a/wordlist.txt
+++ b/wordlist.txt
@@ -1,8 +1,8 @@
 Ack
 activePublicKey
 AES
-apis
 APIs
+apis
 Babik
 backend
 BIP
@@ -14,9 +14,9 @@ blockchain
 BundleContainer
 chainId
 Changelog
-chatid
 chatId
 chatID
+chatid
 ChatMessage
 contactCode
 contactcode
@@ -39,8 +39,8 @@ decrypted
 decrypting
 deserialized
 deterministically
-devP
 devp
+devP
 devP2P
 dh
 DHT
@@ -50,8 +50,8 @@ discoverable
 DNS
 DoS
 ECDSA
-ECIES
 ecies
+ECIES
 ECR
 EDN
 EE
@@ -101,9 +101,9 @@ Jacek
 JSON
 kademlia
 kb
-KECCAK
 Keccak
 keccak
+KECCAK
 keycard
 keypair
 keypairs
@@ -115,8 +115,8 @@ libp
 lifecycle
 mailserver
 Mailserver's
-mailservers
 Mailservers
+mailservers
 mainnet
 MembershipUpdateEvent
 MembershipUpdateMessage
@@ -158,6 +158,7 @@ ProtocolMessage
 PSS
 pubkey
 publicKey
+pyspelling
 relayers
 requestMessages
 RLP
@@ -209,3 +210,4 @@ Vp
 Waku
 wei
 Whitepaper
+wordlist