Deploy notes and project status.

README.md

@@ -2,11 +2,11 @@
 
 Synchronet Web API
 
-This doesn't actually do anything yet. I'm messing around with tooling and concepts at the moment.
+This project will remain unstable until the first release of itself and of SPAM. I don't recommend using it or building anything around it until that time, nor am I interested in bug reports or pull requests for the moment.
 
 ## Development Setup
 
-The build process requires that you have `node.js` and `npm` installed. I imagine you can use whatever the current LTS versions are.
+A [.devcontainer](.devcontainer) spec is provided, which provides the necessary environment. If you don't want to use it, just make sure you have a recent `node.js` and `npm` installed.
 
 Install all dependencies by running this in the project's root directory:
 
@@ -14,6 +14,8 @@ Install all dependencies by running this in the project's root directory:
 npm install
 ```
 
+*(This is not a node.js project; node.js is required for the build system, but the built code itself runs in Synchronet's JS environment.)*
+
 ## Building
 
 Run this in the project's root directory:
@@ -23,3 +25,26 @@ npm run build
 ```
 
 You should find the bundled and transpiled script(s) in the `build/ssjs` directory.
+
+### Build & Deploy
+
+Create a `.env` file in the project's root directory and populate it with:
+
+```ini
+SSH_HOST=your-bbs-address
+SSH_PORT=22
+SSH_USER=sbbs
+DEPLOY_PATH=/sbbs/www/swapi
+```
+
+Note that `SSH_PORT` is **not** the SSH port of your BBS terminal server. The goal here is to `scp` the built scripts onto your BBS server's filesystem. You've probably got OpenSSH listening on some other port, right?
+
+For best results, set up key-based authentication for `SSH_USER` ahead of time.
+
+Run this in the project's root directory:
+
+```sh
+npm run deploy
+```
+
+The project will be built and copied to your server.