Better README

Railgun-Community · May 16, 2024 · 794ce22 · 794ce22
1 parent 3525b13
commit 794ce22
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 42 deletions.
diff --git a/.github/workflows/publish-npmjs.yml b/.github/workflows/publish-npmjs.yml
diff --git a/README.md b/README.md
@@ -39,7 +39,10 @@ Same as `npm run build-debug` but, builds the module with the [`release`](https:
 
 Runs the unit tests.
 
-## Making prebuilds
+## Releasing new versions
+
+You must first compile "prebuilds" for Android and iOS and this may require running on a macOS computer which has iOS specific CLI tools.
+
 
 ### For Android
 
@@ -101,3 +104,11 @@ npx prebuild-for-nodejs-mobile ios-arm64-simulator --verbose
 ```
 npx prebuild-for-nodejs-mobile ios-x64-simulator --verbose
 ```
+
+### Publishing on npm
+
+When the prebuilds are ready, make sure you have rights to publish to the `@railgun-community/poseidon-hash-rsjs` npm package, and then run
+
+```
+npm publish --access public
+```