Update readme and version (#7)

Mostly to test the changesets integration
hyperlane-xyz · Apr 9, 2024 · 1c3e981 · 1c3e981
2 parents 44b257e + 928bc0b
commit 1c3e981
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/.changeset/fast-kings-sip.md b/.changeset/fast-kings-sip.md
@@ -0,0 +1,5 @@
+---
+'@hyperlane-xyz/registry': patch
+---
+
+Initial release
diff --git a/README.md b/README.md
@@ -20,3 +20,18 @@ Configs and artifacts for [Hyperlane Core Contract](https://docs.hyperlane.xyz/d
 #### Warp
 
 Address artifacts for [Warp Route](https://docs.hyperlane.xyz/docs/deploy/deploy-warp-route) token deployments.
+
+## Usage
+
+### Via the NPM package
+
+```sh
+# With npm
+npm install @hyperlane-xyz/registry
+# Or with yarn
+yarn add @hyperlane-xyz/registry
+```
+
+### Via SDK utilities
+
+_Coming soon!_
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@hyperlane-xyz/registry",
   "description": "A collection of configs, artifacts, and schemas for Hyperlane",
-  "version": "1.0.0-beta1",
+  "version": "1.0.0",
   "devDependencies": {
     "@changesets/cli": "^2.26.2",
     "@hyperlane-xyz/sdk": "3.10.0",