chore: use prepare script to auto-build after install (storacha#210)

Adds a
[`prepare`](https://docs.npmjs.com/cli/v6/using-npm/scripts#life-cycle-scripts)
script to automatically run `build` and `compile` after `install`. This
gives us one fewer steps to get started and is a good habit as prepare
also runs if folks depend on your modules from a git branch or similar.

see: https://docs.npmjs.com/cli/v6/using-npm/scripts#life-cycle-scripts

Also:
- updates an old ref to `npm` in the scripts
- removes `build` and `compile` from CI action as it's included in
`install` now thanks to `prepare`
- updates example readmes to remove `build` step
- adds us as maintainers!
- adds `package-lock.json` to gitignore so we don't get double lock
madness.


License: MIT
Signed-off-by: Oli Evans <[email protected]>

.github/actions/test/action.yml

@@ -15,9 +15,5 @@ runs:
             args: [--frozen-lockfile, --strict-peer-dependencies]
     - run: pnpm run lint
       shell: bash
-    - run: pnpm run compile
-      shell: bash
-    - run: pnpm run build
-      shell: bash
     - run: pnpm test
       shell: bash

.gitignore

@@ -1,3 +1,4 @@
 build
 coverage
 node_modules
+package-lock.json

README.md

@@ -2,6 +2,7 @@
   <a href="https://beta.ui.web3.storage"><img width="250" src="https://bafybeianokbu4dgpfd2mq3za3wejtpscsy25ad6vocmmtxskcq6zig4cuq.ipfs.w3s.link/w3ui-logo-stroke.png" alt="Web3.Storage UI logo" /></a>
 </h1>
 
+
 <h3 align="center">Headless, type-safe, UI components for the next generation Web3.Storage APIs.</h3>
 
 <p align="center">
@@ -16,6 +17,8 @@
 > Open an issue on the repo or reach out to the #web3-storage channel on [IPFS Discord](https://docs.ipfs.tech/community/chat/#discord) if you have any 
 questions!
 
+This repo contains reusauble UI modules for web3.storage in your favourite UI framework, and a set of example apps to see them dance.
+
 ## Documentation
 
 [beta.ui.web3.storage](https://beta.ui.web3.storage)
@@ -46,6 +49,23 @@ questions!
 
 Feel free to join in. All welcome. Please read our [contributing guidelines](https://github.com/web3-storage/w3ui/blob/main/CONTRIBUTING.md) and/or [open an issue](https://github.com/web3-storage/w3ui/issues)!
 
+### Getting started
+
+To contribute to this project, clone the w3ui repository and enter the `w3ui` directory
+
+  ```sh
+  git clone https://github.com/web3-storage/w3ui
+  cd w3ui
+  ```
+
+Install dependencies and build:
+
+  ```sh
+  pnpm install
+  ```
+
+Then pick an example app from the list, `cd` into it's directory and run `pnpm start` to try it out.
+
 ## License
 
 Dual-licensed under [MIT + Apache 2.0](https://github.com/web3-storage/w3ui/blob/main/LICENSE.md)

examples/solid/file-upload/README.md

@@ -13,7 +13,6 @@ To run this example:
 
   ```sh
   npm install
-  npm run build
   ```
 
 - Change to this example directory and run the example:

examples/solid/multi-file-upload/README.md

@@ -13,7 +13,6 @@ To run this example:
 
   ```sh
   npm install
-  npm run build
   ```
 
 - Change to this example directory and run the example:

examples/solid/sign-up-in/README.md

@@ -13,7 +13,6 @@ To run this example:
 
   ```sh
   npm install
-  npm run build
   ```
 
 - Change to this example directory and run the example:

examples/solid/template/README.md

@@ -13,7 +13,6 @@ To run this example:
 
   ```sh
   npm install
-  npm run build
   ```
 
 - Change to this example directory and run the example:

examples/solid/uploads-list/README.md

@@ -13,7 +13,6 @@ To run this example:
 
   ```sh
   npm install
-  npm run build
   ```
 
 - Change to this example directory and run the example:

examples/vue/file-upload/README.md

@@ -13,7 +13,6 @@ To run this example:
 
   ```sh
   npm install
-  npm run build
   ```
 
 - Change to this example directory and run the example:

examples/vue/sign-up-in/README.md

@@ -13,7 +13,6 @@ To run this example:
 
   ```sh
   npm install
-  npm run build
   ```
 
 - Change to this example directory and run the example:

examples/vue/template/README.md

@@ -13,7 +13,6 @@ To run this example:
 
   ```sh
   npm install
-  npm run build
   ```
 
 - Change to this example directory and run the example:

examples/vue/uploads-list/README.md

@@ -13,7 +13,6 @@ To run this example:
 
   ```sh
   npm install
-  npm run build
   ```
 
 - Change to this example directory and run the example:

package.json

@@ -4,9 +4,11 @@
   "version": "0.0.0",
   "description": "Headless, type-safe, UI components for the next generation Web3.Storage APIs.",
   "author": "Alan Shaw",
+  "maintainers": [ "travis", "yusefnapora", "olizilla" ],
   "license": "Apache-2.0 OR MIT",
   "scripts": {
-    "build": "rollup --config rollup.config.js && npm run typecheck",
+    "prepare": "pnpm run build && pnpm run compile",
+    "build": "rollup --config rollup.config.js && pnpm run typecheck",
     "clean": "rm -rf node_modules package-lock.json coverage packages/*/{package-lock.json,build,node_modules}",
     "compile": "pnpm run --recursive --if-present compile",
     "lint": "ts-standard",