Merge pull request #61 from Zondax/dev

Fix npm readme

Author: ftheirs

.github/workflows/publish.yaml

@@ -27,6 +27,7 @@ jobs:
         with:
           registry-url: 'https://registry.npmjs.org'
           scope: '@zondax'
+      - run: mv README-npm.md README.md
       - name: Install yarn
         run: npm install -g yarn
       - run: yarn install

README-npm.md

@@ -0,0 +1,46 @@
+# @zondax/ledger-cosmos-js
+
+![zondax](docs/zondax_light.png)
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Main](https://github.com/Zondax/ledger-cosmos-js/workflows/Main/badge.svg)](https://github.com/Zondax/ledger-cosmos-js/actions?query=workflow%3AMain)
+[![npm version](https://badge.fury.io/js/%40zondax%2Fledger-cosmos-js.svg)](https://badge.fury.io/js/%40zondax%2Fledger-cosmos-js)
+
+
+This package provides a basic client library to communicate with a Tendermint/Cosmos App running in a Ledger Nano S/S+/X devices
+
+We recommend using the npmjs package in order to receive updates/fixes.
+
+
+# Available commands
+
+| Operation  | Response         | Command                           |
+| ---------- | ---------------- | -----------------------           |
+| getVersion | app version      | ---------------                   |
+| publicKey  | pubkey            | path (legacy command)            |
+| getAddressAndPubKey | pubkey + address | path + ( showInDevice )  |
+| showAddressAndPubKey       | signed message   | path              |
+| appInfo       | name, version, flags, etc   | ---------------                |
+| deviceInfo       | fw and mcu version, id, etc   | Only available in dashboard             |
+| sign       | signed message   | path + message                    |
+
+
+getAddress command requires that you set the derivation path (account, change, index) and has an option parameter to display the address on the device. By default, it will retrieve the information without user confirmation.
+
+
+# Testing with real devices
+
+It is possible to test this package with a real Ledger Nano device. To accomplish that, you will need to follow these steps:
+
+- Install the application in the Ledger device
+- Install the dependencies from this project
+- Run tests
+
+```shell script
+yarn install
+yarn test:integration
+```
+
+# Who we are?
+
+We are Zondax, a company pioneering blockchain services. If you want to know more about us, please visit us at [zondax.ch](https://zondax.ch)

package.json

@@ -2,7 +2,7 @@
   "name": "@zondax/ledger-cosmos-js",
   "author": "ZondaX AG",
   "license": "Apache-2.0",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Node API for Cosmos App (Ledger Nano S/S+/X)",
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",