From b1f1ea6ef0f7e5e56876887b654b547dc6c46742 Mon Sep 17 00:00:00 2001 From: Jef LeCompte Date: Tue, 10 Nov 2020 17:19:39 -0500 Subject: [PATCH] docs: update `README` to reflect branches Signed-off-by: Jef LeCompte --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 75889e9..7f84fbc 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,11 @@ getting `streetmerchant` running! ### Installation: native +| Branch | Note | +|:---:|---| +| `main` | Latest release; usually tagged, stable | +| `develop` | Latest HEAD; not tagged, could be unstable | + - [Node.js 14](https://nodejs.org/en/) - [git](https://git-scm.com/) - Clone this project `git clone https://github.com/jef/streetmerchant.git` @@ -47,8 +52,8 @@ Available via GitHub Container Registry. | Tag | Note | |:---:|---| -| `latest` | Latest stable build | -| `nightly` | Latest HEAD build, could be unstable | +| `latest` | Latest release; usually tagged, stable | +| `nightly` | Latest HEAD; not tagged, could be unstable | ```sh # to run