From e4dda204c5660e5f5cb8a6456ba951b838d2ed26 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Leszczy=C5=84ski?= Date: Thu, 2 Mar 2023 02:36:20 +0100 Subject: [PATCH] Improve docs and README (#12) --- README.md | 6 +++--- cli/README.md | 4 ++++ docs/{api-exec-halo-cmd-pcsc.md => api-pcsc.md} | 0 ...{api-init-nfc-manager-halo.md => api-react-native.md} | 0 docs/{api-exec-cmd-web.md => api-web.md} | 0 docs/desktop-api.md | 2 +- docs/halo-command-set.md | 9 +++++++++ docs/mobile-react-native.md | 2 +- docs/web-reactjs.md | 2 +- docs/web-standalone.md | 2 +- 10 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 cli/README.md rename docs/{api-exec-halo-cmd-pcsc.md => api-pcsc.md} (100%) rename docs/{api-init-nfc-manager-halo.md => api-react-native.md} (100%) rename docs/{api-exec-cmd-web.md => api-web.md} (100%) diff --git a/README.md b/README.md index d2fe5c9..e9c04a8 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/cli/README.md b/cli/README.md new file mode 100644 index 0000000..da02395 --- /dev/null +++ b/cli/README.md @@ -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) diff --git a/docs/api-exec-halo-cmd-pcsc.md b/docs/api-pcsc.md similarity index 100% rename from docs/api-exec-halo-cmd-pcsc.md rename to docs/api-pcsc.md diff --git a/docs/api-init-nfc-manager-halo.md b/docs/api-react-native.md similarity index 100% rename from docs/api-init-nfc-manager-halo.md rename to docs/api-react-native.md diff --git a/docs/api-exec-cmd-web.md b/docs/api-web.md similarity index 100% rename from docs/api-exec-cmd-web.md rename to docs/api-web.md diff --git a/docs/desktop-api.md b/docs/desktop-api.md index f12d0ac..a55af88 100644 --- a/docs/desktop-api.md +++ b/docs/desktop-api.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 diff --git a/docs/halo-command-set.md b/docs/halo-command-set.md index 24812aa..cc2db2c 100644 --- a/docs/halo-command-set.md +++ b/docs/halo-command-set.md @@ -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. diff --git a/docs/mobile-react-native.md b/docs/mobile-react-native.md index bfac518..b3f6a13 100644 --- a/docs/mobile-react-native.md +++ b/docs/mobile-react-native.md @@ -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) diff --git a/docs/web-reactjs.md b/docs/web-reactjs.md index 9825498..c155a7c 100644 --- a/docs/web-reactjs.md +++ b/docs/web-reactjs.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) diff --git a/docs/web-standalone.md b/docs/web-standalone.md index 7d0f5fe..fd91583 100644 --- a/docs/web-standalone.md +++ b/docs/web-standalone.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