diff --git a/README.md b/README.md index 4db307d..239aa06 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,21 @@ # Zooboard -To develop: +To run it yourself: 1. `npm install` -2. `npm start` in one terminal, `npm run electron` in another -3. Edit JS code -4. Sometimes you may need to re-run step 2 +2. Download, install, and run [pzp-hub][pzp-hub]. +3. In the zooboard repo, `npm run start-all` + +To run with a friend: +1. Both `npm install` +2. One of you downloads, installs, and runs [pzp-hub][pzp-hub] on a machine with a public IP. +3. You both, in the zooboard repo, run `npm start` in one terminal and `npm run electron` in another. + +To use: +1. One peer goes to the hub website (default on localhost is [0.0.0.0:3000](http://0.0.0.0:3000)), gets the admin invite, and uses it in the app by clicking "Join". +2. That peer clicks "Invite" in the app and gives that invite to the other peer. +3. The other peer uses that invite by clicking "Join". +4. Draw together and be happy! +5. [Discuss bugs here](https://codeberg.org/pzp/pzp-hub/issues) or pzp in general on the #pzp hashtag on your preferred social network. + +[pzp-hub]: https://codeberg.org/pzp/pzp-hub \ No newline at end of file