mirror of https://github.com/status-im/specs.git
parent
56d5a2ff39
commit
2b0604077d
21
README.md
21
README.md
|
@ -18,6 +18,27 @@ its various capabilities.
|
||||||
|
|
||||||
If you need help, ask in #protocol at Status / Discord.
|
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
|
## 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/):
|
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/):
|
||||||
|
|
14
wordlist.txt
14
wordlist.txt
|
@ -1,8 +1,8 @@
|
||||||
Ack
|
Ack
|
||||||
activePublicKey
|
activePublicKey
|
||||||
AES
|
AES
|
||||||
apis
|
|
||||||
APIs
|
APIs
|
||||||
|
apis
|
||||||
Babik
|
Babik
|
||||||
backend
|
backend
|
||||||
BIP
|
BIP
|
||||||
|
@ -14,9 +14,9 @@ blockchain
|
||||||
BundleContainer
|
BundleContainer
|
||||||
chainId
|
chainId
|
||||||
Changelog
|
Changelog
|
||||||
chatid
|
|
||||||
chatId
|
chatId
|
||||||
chatID
|
chatID
|
||||||
|
chatid
|
||||||
ChatMessage
|
ChatMessage
|
||||||
contactCode
|
contactCode
|
||||||
contactcode
|
contactcode
|
||||||
|
@ -39,8 +39,8 @@ decrypted
|
||||||
decrypting
|
decrypting
|
||||||
deserialized
|
deserialized
|
||||||
deterministically
|
deterministically
|
||||||
devP
|
|
||||||
devp
|
devp
|
||||||
|
devP
|
||||||
devP2P
|
devP2P
|
||||||
dh
|
dh
|
||||||
DHT
|
DHT
|
||||||
|
@ -50,8 +50,8 @@ discoverable
|
||||||
DNS
|
DNS
|
||||||
DoS
|
DoS
|
||||||
ECDSA
|
ECDSA
|
||||||
ECIES
|
|
||||||
ecies
|
ecies
|
||||||
|
ECIES
|
||||||
ECR
|
ECR
|
||||||
EDN
|
EDN
|
||||||
EE
|
EE
|
||||||
|
@ -101,9 +101,9 @@ Jacek
|
||||||
JSON
|
JSON
|
||||||
kademlia
|
kademlia
|
||||||
kb
|
kb
|
||||||
KECCAK
|
|
||||||
Keccak
|
Keccak
|
||||||
keccak
|
keccak
|
||||||
|
KECCAK
|
||||||
keycard
|
keycard
|
||||||
keypair
|
keypair
|
||||||
keypairs
|
keypairs
|
||||||
|
@ -115,8 +115,8 @@ libp
|
||||||
lifecycle
|
lifecycle
|
||||||
mailserver
|
mailserver
|
||||||
Mailserver's
|
Mailserver's
|
||||||
mailservers
|
|
||||||
Mailservers
|
Mailservers
|
||||||
|
mailservers
|
||||||
mainnet
|
mainnet
|
||||||
MembershipUpdateEvent
|
MembershipUpdateEvent
|
||||||
MembershipUpdateMessage
|
MembershipUpdateMessage
|
||||||
|
@ -158,6 +158,7 @@ ProtocolMessage
|
||||||
PSS
|
PSS
|
||||||
pubkey
|
pubkey
|
||||||
publicKey
|
publicKey
|
||||||
|
pyspelling
|
||||||
relayers
|
relayers
|
||||||
requestMessages
|
requestMessages
|
||||||
RLP
|
RLP
|
||||||
|
@ -209,3 +210,4 @@ Vp
|
||||||
Waku
|
Waku
|
||||||
wei
|
wei
|
||||||
Whitepaper
|
Whitepaper
|
||||||
|
wordlist
|
||||||
|
|
Loading…
Reference in New Issue