Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dworthen committed Apr 5, 2024
1 parent adfccc6 commit 123b14b
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,24 @@

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`.

```
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.

0 comments on commit 123b14b

Please sign in to comment.