From 123b14b626f3b2a9eef988f9e21c393d3ce874c2 Mon Sep 17 00:00:00 2001
From: Derek Worthen <worthend.derek@gmail.com>
Date: Fri, 5 Apr 2024 09:49:24 -0700
Subject: [PATCH] update docs

---
 README.md | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index ef7b23f..6fb247a 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,10 @@
 
 A JavScript wrapper to https://github.com/gov4git/gov4git
 
-## Build & Install
+## Install
 
 ```bash
-git clone https://github.com/gov4git/js-client gov4git-js-client
-cd gov4git-js-client
-npm install
-npm build
-npm link .
+npm install -g @gov4git/js-client
 ```
 
 You should then be able to run `gov4git` commands or the alias `g4g`.
@@ -17,3 +13,13 @@ You should then be able to run `gov4git` commands or the alias `g4g`.
 ```
 g4g --help
 ```
+
+## Updating to a newer version of the GitRules Protocol
+
+A new version of this package needs to be released whenever [GitRules](https://github.com/gov4git/gov4git) releases a new version.
+
+### Update process
+
+1. Update the `archive-downloader.variables.version` field in `package.json` to the new version of GitRules.
+2. Update the `version` field in `package.json` (typically matching the new version of GitRules)
+3. When these changes make it to the main branch, a GitHub action will automatically deploy a new npm package.