update readme

Author: artursapek

.github/workflows/lint.yml .github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Lint
+name: Build
 
 on:
   pull_request:

.github/workflows/publish.yml

@@ -27,6 +27,8 @@ jobs:
           IFS='@' read -a strarr <<< $(git describe --tags)
           sed  -i "s/\"version\": .*/\"version\": \"${strarr[1]}$(echo $([ ${strarr[0]} == "production" ] && echo "" || echo "-${strarr[0]}"))\",/" wormhole-connect/package.json
           npm run build
+          cp README.md wormhole-connect/
+          cp wormhole-connect.png wormhole-connect/
           cd wormhole-connect
           npm publish --tag $(echo $([ ${strarr[0]} == "production" ] && echo "latest" || echo ${strarr[0]})) --access public
         env:

CONTRIBUTING.md

@@ -1,3 +1,31 @@
+## Contributing
+
+Contributions are welcome! To work on wormhole-connect locally you'll want to use `npm link` to make the changes to the SDK immediately available.
+
+### Setup
+
+1) Install
+
+Run `npm i` at the root of the repo
+
+2) Build
+
+Run `npm run build` at the root fo the repo
+
+3) Start
+
+Start wormhole-connect UI and view in browser at localhost:3000
+```bash
+# in /wormhole-connect
+npm run start # testnet
+```
+
+Start builder UI and view in browser at localhost:3000
+```bash
+# in /builder
+npm run start
+```
+
 ## Add a token
 
 ### Fill out token config
@@ -52,4 +80,4 @@ Copy the outputted list and paste it into `src/consts/wallet.ts` as the value of
 
 1. Make a GitHub release
 2. Tag it `production@0.1.3`
-3. Trigger the 'publish' GitHub action and fill in the tag when prompted, which will publish to NPM
+3. Trigger the 'publish' GitHub action and fill in the tag when prompted, which will publish to NPM