Skip to content

Commit

Permalink
Merge pull request #53 from sarcophagus-org/sethhrbek-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
sethhrbek authored Nov 9, 2023
2 parents 1976f92 + c3d09af commit aaee228
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,16 @@ npm link sarcophagus-v2-sdk

Then it may be imported as if it were added to the package.json.

## Deployment
To deploy a new version of the SDK:
1. Increment the package version in package.json (i.e. `"version": "0.2.37"`)
2. Merge code into the `main` branch
3. Create & Publish a new release
- The release will require a new tag, you can create the tag in the release
- As a naming convention for the release, name the tag the SDK version (i.e. 0.3.37), and also name the release the same name (0.3.37).

Once the release is published, the SDK packages will be automatically built with a github action and published to npm.

## Contributing

We welcome contributions to the SDK. If you'd like to contribute, please submit an issue or open a pull request.
Expand Down

0 comments on commit aaee228

Please sign in to comment.