Merge pull request #1163 from oasisprotocol/pro-wh/feature/docs

ts-web/core: docs additions

client-sdk/ts-web/README.md

@@ -0,0 +1,17 @@
+# Outer workspace for packages
+
+This directory is an
+[npm workspace](https://docs.npmjs.com/cli/v8/using-npm/workspaces) that helps
+us link the contained packages into each other's dependencies.
+
+## Building the packages
+
+In this directory, run:
+
+```sh
+npm i --foreground-scripts
+```
+
+The `--foreground-scripts` option instructs npm to compile (TypeScript)
+depended-on packages before compiling packages that depend on them.
+[Tracked](https://github.com/npm/cli/issues/4100).

client-sdk/ts-web/core/README.md

@@ -1,6 +1,6 @@
 # An oasis-core SDK for TypeScript
 
-Developers, see [this getting started guide](docs/getting-started.md).
+Users of this package, see [this getting started guide](docs/getting-started.md).
 
 ## Philosophy
 

client-sdk/ts-web/core/docs/getting-started.md

@@ -12,7 +12,10 @@ npm install @oasisprotocol/client@alpha
 ```
 
 Install this package [from
-npm](https://www.npmjs.com/package/@oasisprotocol/client).
+npm](https://www.npmjs.com/package/@oasisprotocol/client?activeTab=versions).
+The `@alpha` is needed because we are publishing to the `alpha` tag.
+Due to technical limitations, npm has also created a `latest` tag which is
+stuck at a very old alpha verison.
 
 **TODO: Update this command when this library gets out of alpha.**
 
@@ -33,6 +36,11 @@ For security and performance reasons, some methods are not permitted.
 See the Advanced deployment section below for how to set up your own node with
 a custom set of enabled methods.
 
+## Running in Node.js
+
+This package and some of its dependencies do not support running in Node.js.
+Only use this package in browsers.
+
 # Example code
 
 We have [a few sample interactions](../playground/src/index.js).