Skip to content

Commit 5912f00

Browse files
authored
feat: improve docs (#2)
1 parent c3a55cb commit 5912f00

File tree

2 files changed

+28
-4
lines changed

2 files changed

+28
-4
lines changed

README-npm.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ This package provides a basic client library to communicate with the Ironfish Ap
77

88
We recommend using the npmjs package in order to receive updates/fixes.
99

10-
## Notes
11-
1210
Use `yarn install` to avoid issues.
11+
12+
# Available commands
13+
14+
| Operation | Response | Command |
15+
|--------------|------------------------------------------|-------------------------------|
16+
| getVersion | app version | --------------- |
17+
| appInfo | name, version, flags, etc | --------------- |
18+
| deviceInfo | fw and mcu version, id, etc | Only available in dashboard |
19+
| sign | signed message | path + message |
20+
| retrieveKeys | address or view key or proof gen key | path + key type + verify flag |
21+
22+
# Who we are?
23+
24+
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)

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,18 @@ This package provides a basic client library to communicate with the Ironfish Ap
77

88
We recommend using the npmjs package in order to receive updates/fixes.
99

10-
## Notes
11-
1210
Use `yarn install` to avoid issues.
11+
12+
# Available commands
13+
14+
| Operation | Response | Command |
15+
|--------------|------------------------------------------|-------------------------------|
16+
| getVersion | app version | --------------- |
17+
| appInfo | name, version, flags, etc | --------------- |
18+
| deviceInfo | fw and mcu version, id, etc | Only available in dashboard |
19+
| sign | signed message | path + message |
20+
| retrieveKeys | address or view key or proof gen key | path + key type + verify flag |
21+
22+
# Who we are?
23+
24+
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)

0 commit comments

Comments
 (0)