mirror of
https://github.com/aljazceru/ark.git
synced 2025-12-17 04:04:21 +01:00
Improve README (#157)
* Prepare for default liquid, README and Release GH action * improve README
This commit is contained in:
@@ -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
|
||||
|
||||
|
||||
29
client/README.md
Normal file
29
client/README.md
Normal file
@@ -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 <command>` to get detailed help for the command.
|
||||
|
||||
## Version
|
||||
|
||||
The current version of Ark CLI is alpha stage.
|
||||
Reference in New Issue
Block a user