feat: adjust readme

Zondax · Jan 13, 2025 · b71172b · b71172b
1 parent 4d70ce0
commit b71172b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/README-npm.md b/README-npm.md
@@ -0,0 +1,12 @@
+# ledger-zcash-js
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![npm version](https://badge.fury.io/js/%40zondax%2Fledger-zcash.svg)](https://badge.fury.io/js/%40zondax%2Fledger-zcash)
+
+This package provides a basic client library to communicate with the Zcash App running in a Ledger Nano S, S+ and X, Flex and Stax.
+
+We recommend using the npmjs package in order to receive updates/fixes.
+
+## Notes
+
+Use `yarn install` to avoid issues.
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![npm version](https://badge.fury.io/js/%40zondax%2Fledger-zcash.svg)](https://badge.fury.io/js/%40zondax%2Fledger-zcash)
 
-This package provides a basic client library to communicate with the Zcash App running in a Ledger Nano S/X
+This package provides a basic client library to communicate with the Zcash App running in a Ledger Nano S, S+ and X, Flex and Stax.
 
 We recommend using the npmjs package in order to receive updates/fixes.