chore: improve docs (#245)

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -3,7 +3,6 @@ description: "Create a report to help us improve"
 title: "[bug]: "
 labels: ["bug", "unconfirmed"]
 assignees:
- - BeroBurny
 body:
   - type: textarea
     id: description
@@ -38,7 +37,7 @@ body:
     attributes:
       label: Expected behavior
       description: A clear and concise description of what you expected to happen.
-      placeholder: When i click shoud work fine
+      placeholder: When i click should work fine
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -3,7 +3,6 @@ description: "Request new Feature to adapter/snap"
 title: "[feature]: "
 labels: ["enhancement", "unconfirmed"]
 assignees:
- - BeroBurny
 body:
   - type: textarea
     id: summary

README.md

@@ -1,29 +1,42 @@
 # FilSnap
 ![](https://github.com/chainsafe/filsnap/workflows/ci/badge.svg)
-![](https://img.shields.io/badge/yarn-%3E%3D1.17.0-orange.svg?style=flat-square)
-![](https://img.shields.io/badge/Node.js-%3E%3D12.x-orange.svg?style=flat-square)
-![Discord](https://img.shields.io/discord/608204864593461248?color=blue&label=Discord&logo=discord)
+![](https://img.shields.io/badge/yarn-%3E%3D3-orange)
+![](https://img.shields.io/badge/Node.js-%3E%3D16-orange)
 
 Snap to enable MetaMask users interaction with filecoin dapps. For detailed documentation and integration instructions see our [wiki](https://github.com/chainsafe/filsnap/wiki).
 
 ## Testing FilSnap
 
 ### MetaMask Flask
-Snaps is pre-release software available in MetaMask Flask, a canary distribution for developers that provides access to upcoming features. To try Snaps, either [install MetaMask Flask](https://metamask.io/flask/) or build it locally.
-
-#### Build MetaMask Flask locally
-- checkout to [this branch](https://github.com/MetaMask/metamask-extension/tree/snaps-stable-nov-21) (Chrome recommended)
-- build MetaMask using `yarn start --build-type flask` or `yarn dist`
-- go to [chrome://extensions/](chrome://extensions/)
-- enable "Developer mode"
-- click "Load unpacked" and point to chrome directory
+Snaps is pre-release software available in MetaMask Flask, a canary distribution for developers that provides access to upcoming features. To try Snaps [install MetaMask Flask](https://metamask.io/flask/).
 
 ### Live demo dapp
 Test FilSnap inside [our demo dapp](http://filsnap.chainsafe.io/).
 
-### Running our demo dapp locally
-```shell
-corepack enable && yarn install && yarn run demo
+## Development
+
+### Requirements
+```
+node version 16 or above
+```
+
+### Usage
+* For nvm users
+```sh
+nvm use
+```
+---
+* Enable corepack
+```sh
+corepack enable
+```
+* Install packages
+```sh
+yarn install
+```
+* Run local snap server and React Demo page 
+```sh
+yarn demo
 ```
 
 ## License

package.json

@@ -3,7 +3,7 @@
   "private": true,
   "author": "ChainSafe <[email protected]>",
   "license": "(Apache-2.0 AND MIT)",
-  "packageManager": "yarn@3.2.3",
+  "packageManager": "yarn@3.4.1",
   "workspaces": [
     "packages/*"
   ],

yarn.lock

@@ -10290,7 +10290,7 @@ __metadata:
 
 "fsevents@patch:fsevents@^1.2.7#~builtin<compat/fsevents>":
   version: 1.2.13
-  resolution: "fsevents@patch:fsevents@npm%3A1.2.13#~builtin<compat/fsevents>::version=1.2.13&hash=18f3a7"
+  resolution: "fsevents@patch:fsevents@npm%3A1.2.13#~builtin<compat/fsevents>::version=1.2.13&hash=d11327"
   dependencies:
     bindings: ^1.5.0
     nan: ^2.12.1
@@ -10300,7 +10300,7 @@ __metadata:
 
 "fsevents@patch:fsevents@^2.1.2#~builtin<compat/fsevents>, fsevents@patch:fsevents@^2.1.3#~builtin<compat/fsevents>, fsevents@patch:fsevents@~2.3.2#~builtin<compat/fsevents>":
   version: 2.3.2
-  resolution: "fsevents@patch:fsevents@npm%3A2.3.2#~builtin<compat/fsevents>::version=2.3.2&hash=18f3a7"
+  resolution: "fsevents@patch:fsevents@npm%3A2.3.2#~builtin<compat/fsevents>::version=2.3.2&hash=df0bf1"
   dependencies:
     node-gyp: latest
   conditions: os=darwin
@@ -17364,7 +17364,7 @@ __metadata:
 
 "resolve@patch:[email protected]#~builtin<compat/resolve>":
   version: 1.18.1
-  resolution: "resolve@patch:resolve@npm%3A1.18.1#~builtin<compat/resolve>::version=1.18.1&hash=07638b"
+  resolution: "resolve@patch:resolve@npm%3A1.18.1#~builtin<compat/resolve>::version=1.18.1&hash=c3c19d"
   dependencies:
     is-core-module: ^2.0.0
     path-parse: ^1.0.6
@@ -17374,7 +17374,7 @@ __metadata:
 
 "resolve@patch:resolve@^1.1.4#~builtin<compat/resolve>, resolve@patch:resolve@^1.10.0#~builtin<compat/resolve>, resolve@patch:resolve@^1.12.0#~builtin<compat/resolve>, resolve@patch:resolve@^1.14.2#~builtin<compat/resolve>, resolve@patch:resolve@^1.17.0#~builtin<compat/resolve>, resolve@patch:resolve@^1.18.1#~builtin<compat/resolve>, resolve@patch:resolve@^1.19.0#~builtin<compat/resolve>, resolve@patch:resolve@^1.20.0#~builtin<compat/resolve>, resolve@patch:resolve@^1.22.0#~builtin<compat/resolve>, resolve@patch:resolve@^1.3.2#~builtin<compat/resolve>, resolve@patch:resolve@^1.4.0#~builtin<compat/resolve>":
   version: 1.22.1
-  resolution: "resolve@patch:resolve@npm%3A1.22.1#~builtin<compat/resolve>::version=1.22.1&hash=07638b"
+  resolution: "resolve@patch:resolve@npm%3A1.22.1#~builtin<compat/resolve>::version=1.22.1&hash=c3c19d"
   dependencies:
     is-core-module: ^2.9.0
     path-parse: ^1.0.7
@@ -17387,7 +17387,7 @@ __metadata:
 
 "resolve@patch:resolve@^2.0.0-next.3#~builtin<compat/resolve>":
   version: 2.0.0-next.4
-  resolution: "resolve@patch:resolve@npm%3A2.0.0-next.4#~builtin<compat/resolve>::version=2.0.0-next.4&hash=07638b"
+  resolution: "resolve@patch:resolve@npm%3A2.0.0-next.4#~builtin<compat/resolve>::version=2.0.0-next.4&hash=c3c19d"
   dependencies:
     is-core-module: ^2.9.0
     path-parse: ^1.0.7
@@ -19636,7 +19636,7 @@ __metadata:
 
 "typescript@patch:[email protected]#~builtin<compat/typescript>":
   version: 4.3.5
-  resolution: "typescript@patch:typescript@npm%3A4.3.5#~builtin<compat/typescript>::version=4.3.5&hash=a1c5e5"
+  resolution: "typescript@patch:typescript@npm%3A4.3.5#~builtin<compat/typescript>::version=4.3.5&hash=dba6d9"
   bin:
     tsc: bin/tsc
     tsserver: bin/tsserver
@@ -19646,7 +19646,7 @@ __metadata:
 
 "typescript@patch:[email protected]#~builtin<compat/typescript>":
   version: 4.6.4
-  resolution: "typescript@patch:typescript@npm%3A4.6.4#~builtin<compat/typescript>::version=4.6.4&hash=a1c5e5"
+  resolution: "typescript@patch:typescript@npm%3A4.6.4#~builtin<compat/typescript>::version=4.6.4&hash=5d3a66"
   bin:
     tsc: bin/tsc
     tsserver: bin/tsserver
@@ -19656,7 +19656,7 @@ __metadata:
 
 "typescript@patch:[email protected]#~builtin<compat/typescript>":
   version: 4.7.4
-  resolution: "typescript@patch:typescript@npm%3A4.7.4#~builtin<compat/typescript>::version=4.7.4&hash=a1c5e5"
+  resolution: "typescript@patch:typescript@npm%3A4.7.4#~builtin<compat/typescript>::version=4.7.4&hash=65a307"
   bin:
     tsc: bin/tsc
     tsserver: bin/tsserver