gnd: Update the README for npmjs

Author: lutter

gnd/npm/README.md

@@ -1,30 +1,35 @@
-# gnd npm wrapper
+# Graph Node Development CLI
 
-This directory contains the files used to publish the `@graphprotocol/gnd`
-npm wrapper package. The wrapper package enables installing gnd via npm:
+This package installs the CLI for developing subgraphs for [The Graph
+Network](https://thegraph.com/subgraphs/) It supports all aspects of
+[developing, testing, and deploying subgraphs](https://thegraph.com/docs/en/subgraphs/quick-start/) locally and
+on the network.
 
-```bash
-npm install -g @graphprotocol/gnd
-npx @graphprotocol/gnd
-```
+This package is a complete replacement for the older
+[graph-cli](https://www.npmjs.com/package/@graphprotocol/graph-cli) which
+will over time be migrated to be a simple wrapper for `gnd`. Older
+documentation will reference `graph-cli` in its instructions; running
+`alias graph=gnd` in the shell make it possible to follow these
+instructions verbatim with `gnd`.
 
-## How it works
+Besides the tools to develop subgraphs, `gnd` also contains a version of
+[graph-node](https://github.com/graphprotocol/graph-node) tailored to
+running subgraphs locally via `gnd dev`.
 
-The wrapper declares platform-specific packages as `optionalDependencies`.
-npm only installs the one matching the user's OS and architecture. The
-`bin/gnd.js` script resolves and executes the correct platform binary.
 
-Platform packages:
+## Getting started
 
-- `@graphprotocol/gnd-linux-x64`
-- `@graphprotocol/gnd-linux-arm64`
-- `@graphprotocol/gnd-darwin-x64`
-- `@graphprotocol/gnd-darwin-arm64`
-- `@graphprotocol/gnd-win32-x64`
+Run `npm install -g @graphprotocol/gnd` to install `gnd`.
 
-## Publishing
+After installation, you can create and run an example subgraph locally with
+```bash
+gnd init --from-example ethereum-gravatar 'My new subgraph' new-subgraph
+cd new-subgraph
+gnd codegen
+gnd build
+gnd dev --ethereum-rpc 'mainnet:<RPC URL>'
+```
 
-All packages are published automatically by the `Build gnd Binaries`
-GitHub Actions workflow (`.github/workflows/gnd-binary-build.yml`) when
-dispatched on a tag. Platform packages are published first, then the
-wrapper.
+If you have an existing contract for which you want to write a subgraph,
+have a look at `gnd help init` and the `--from-contract` option. You can
+also simply run `gnd init` and follow the prompts to set up your subgraph.