From abe99caab73edef7b7be5643c061991043e00d28 Mon Sep 17 00:00:00 2001 From: Vaughn Dice Date: Thu, 9 Nov 2023 11:26:14 -0700 Subject: [PATCH] docs(templates): add minimal build/run docs to template READMEs Signed-off-by: Vaughn Dice --- templates/http-js/content/README.md | 19 ++++++++++++++++++- templates/http-ts/content/README.md | 19 ++++++++++++++++++- 2 files changed, 36 insertions(+), 2 deletions(-) diff --git a/templates/http-js/content/README.md b/templates/http-js/content/README.md index e79c80e8..1f32f6c8 100644 --- a/templates/http-js/content/README.md +++ b/templates/http-js/content/README.md @@ -1,3 +1,20 @@ ## HTTP-JS template -This is a simple template to get started with spin-js-sdk. \ No newline at end of file +This is a simple template to get started with spin-js-sdk. + +### Build + +```console +npm install +spin build +``` + +### Run + +```console +spin up +``` + +Or, use `spin watch` to run the app and rebuild on any changes to `package.json` or the files in `src`. + +Use e.g. `curl -v http://127.0.0.1:3000/hello` to test the endpoint. \ No newline at end of file diff --git a/templates/http-ts/content/README.md b/templates/http-ts/content/README.md index f6b05564..df3b99be 100644 --- a/templates/http-ts/content/README.md +++ b/templates/http-ts/content/README.md @@ -1,3 +1,20 @@ ## HTTP-TS template -This is a simple template to get started with spin-js-sdk using typescript. \ No newline at end of file +This is a simple template to get started with spin-js-sdk using typescript. + +### Build + +```console +npm install +spin build +``` + +### Run + +```console +spin up +``` + +Or, use `spin watch` to run the app and rebuild on any changes to `package.json` or the files in `src`. + +Use e.g. `curl -v http://127.0.0.1:3000/hello` to test the endpoint. \ No newline at end of file