mirror of
https://github.com/arx-research/libhalo.git
synced 2026-01-09 05:07:58 -05:00
Improve docs and README (#12)
This commit is contained in:
committed by
GitHub
parent
ef0924c62c
commit
e4dda204c5
@@ -18,7 +18,7 @@ Installation of additional software is not required on the user's side.
|
||||
**Guides:**
|
||||
* [Using libhalo as a standalone library in a classic HTML web application](/docs/web-standalone.md)
|
||||
* [Using libhalo within a React.js web application](/docs/web-reactjs.md)
|
||||
* [Documentation of the execHaloCmdWeb API](/docs/api-exec-cmd-web.md)
|
||||
* [Documentation of the execHaloCmdWeb API](/docs/api-web.md)
|
||||
|
||||
### (React Native) initNFCManagerHalo, execHaloCmd
|
||||
```
|
||||
@@ -33,7 +33,7 @@ For React Native mobile applications (Android/iOS) based on `react-native-nfc-ma
|
||||
|
||||
**Guides:**
|
||||
* [Using libhalo within a React Native mobile application for Android/iOS](/docs/mobile-react-native.md)
|
||||
* [Documentation of the initNFCManagerHalo, execHaloCmd API](/docs/api-init-nfc-manager-halo.md)
|
||||
* [Documentation of the initNFCManagerHalo, execHaloCmd API](/docs/api-react-native.md)
|
||||
|
||||
### (Desktop) execHaloCmdPCSC
|
||||
```
|
||||
@@ -45,7 +45,7 @@ For desktop applications based on `nfc-pcsc` library: scan the HaLo tag present
|
||||
**Guides:**
|
||||
* [Using libhalo as a CLI tool on the desktop computer with PC/SC reader (USB NFC reader)](/docs/desktop-cli.md)
|
||||
* [Using libhalo to build your own application for desktop computers with PC/SC reader (USB NFC reader)](/docs/desktop-api.md)
|
||||
* [Documentation of the execHaloCmdPCSC API](/docs/api-exec-halo-cmd-pcsc.md)
|
||||
* [Documentation of the execHaloCmdPCSC API](/docs/api-pcsc.md)
|
||||
|
||||
## Supported HaLo commands
|
||||
|
||||
|
||||
4
cli/README.md
Normal file
4
cli/README.md
Normal file
@@ -0,0 +1,4 @@
|
||||
# HaLo CLI Tool
|
||||
|
||||
Documentation:
|
||||
* [Using libhalo as a CLI tool on the desktop computer with PC/SC reader (USB NFC reader)](/docs/desktop-cli.md)
|
||||
@@ -70,7 +70,7 @@ console.log('Tap the tag...');
|
||||
|
||||
## Notes
|
||||
|
||||
Please review the [documentation on the execHaloCmdPCSC function](/docs/api-exec-halo-cmd-pcsc.md) to find out
|
||||
Please review the [documentation on the execHaloCmdPCSC function](/docs/api-pcsc.md) to find out
|
||||
the exact specification of the `execHaloCmdPCSC()` function.
|
||||
|
||||
Please review the [documentation of the available commands (Halo Command Set)](/docs/halo-command-set.md) to find
|
||||
|
||||
@@ -1,5 +1,14 @@
|
||||
# HaLo Command Set
|
||||
|
||||
## Table of contents
|
||||
|
||||
* [Command: sign](#command-sign)
|
||||
* [Command: sign_random](#command-sign_random)
|
||||
* [Command: write_latch](#command-write_latch)
|
||||
* [Command: cfg_ndef](#command-cfg_ndef)
|
||||
* [Command: gen_key](#command-gen_key)
|
||||
* [Command: gen_key_confirm](#command-gen_key_confirm)
|
||||
|
||||
## Command: sign
|
||||
|
||||
Sign an arbitrary message using ECDSA/Keccak algorithm or sign a raw digest using plain ECDSA.
|
||||
|
||||
@@ -104,5 +104,5 @@ Please check GitHub [arx-research/libhalo-example-react-native](https://github.c
|
||||
|
||||
## Advanced usage
|
||||
|
||||
* [Documentation of the initNFCManagerHalo API](/docs/api-init-nfc-manager-halo.md)
|
||||
* [Documentation of the initNFCManagerHalo API](/docs/api-react-native.md)
|
||||
* [Documentation of the available commands (HaLo Command Set)](/docs/halo-command-set.md)
|
||||
|
||||
@@ -85,5 +85,5 @@ Please check GitHub [arx-research/libhalo-example-reactjs](https://github.com/ar
|
||||
|
||||
## Advanced usage
|
||||
|
||||
* [Documentation of the execHaloCmdWeb API](/docs/api-exec-cmd-web.md)
|
||||
* [Documentation of the execHaloCmdWeb API](/docs/api-web.md)
|
||||
* [Documentation of the available commands (HaLo Command Set)](/docs/halo-command-set.md)
|
||||
|
||||
@@ -55,7 +55,7 @@ Please review the following demonstrative applications:
|
||||
|
||||
## Advanced usage
|
||||
|
||||
* [Documentation of the execHaloCmdWeb API](/docs/api-exec-cmd-web.md)
|
||||
* [Documentation of the execHaloCmdWeb API](/docs/api-web.md)
|
||||
* [Documentation of the available commands (HaLo Command Set)](/docs/halo-command-set.md)
|
||||
|
||||
## Building library from source
|
||||
|
||||
Reference in New Issue
Block a user