From 30c1df9a66dd5c316dfa414969657d22cf7c96da Mon Sep 17 00:00:00 2001 From: Marco Argentieri <3596602+tiero@users.noreply.github.com> Date: Sat, 27 Apr 2024 03:22:41 +0200 Subject: [PATCH] Improve README (#157) * Prepare for default liquid, README and Release GH action * improve README --- README.md | 6 ++++-- client/README.md | 29 +++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 client/README.md diff --git a/README.md b/README.md index 3ee9a5c..e9d6ef1 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,10 @@ Welcome to the Ark monorepo. In this repository you can find: -- `server` - always-on daemon that serves as the Ark Service Provider (ASP) -- `client` - single-key wallet as command-line interface (CLI) to interact with the ASP +- [`server`](./server/) always-on daemon that serves as the Ark Service Provider (ASP) +- [`client`](./client/) single-key wallet as command-line interface (CLI) to interact with the ASP + +Refer to the README in each directory for more information about development. ## Get Started with Docker diff --git a/client/README.md b/client/README.md new file mode 100644 index 0000000..4cfc445 --- /dev/null +++ b/client/README.md @@ -0,0 +1,29 @@ +# Ark CLI + +Ark CLI is a command line interface for the Ark wallet. It is written in Go and provides a variety of commands to interact with the Ark wallet. + +## Requirements + +- Go 1.16 or higher + +## Installation + +To install Ark CLI, you need to have Go installed on your machine. Once Go is installed, you can build and install Ark CLI using the following command: + +```sh +alias ark='go run main.go' +``` + +## Usage + +You can use Ark CLI by running the ark command followed by the command you want to execute. Here's the general usage: + +```sh +ark [global options] command [command options] [arguments...] +``` + +For more information about each command, you can run `ark help ` to get detailed help for the command. + +## Version + +The current version of Ark CLI is alpha stage.