Skip to content

Commit 80d085a

Browse files
Update README.md (#10)
1 parent 2167fd5 commit 80d085a

File tree

1 file changed

+45
-34
lines changed

1 file changed

+45
-34
lines changed

README.md

Lines changed: 45 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,115 @@
1-
# Atomicals Javascript Library
1+
# Atomicals Command-line Tool
22

3-
Use `yarn` package manager instead of `npm`. Instructions below (They are: `npm install -g yarn`)
3+
The command-line tool to fetch, deploy, mint, transfer, and manipulate Atomicals Digital Assets.
44

5-
In the latest version of the CLI processing library the option switches (the settings starting with `--`) are not processed correctly and it would lead to
6-
too small of a fee being set and result in your transactions not being mined.
5+
Visit the [Atomicals Guidebook](https://atomicals-community.github.io/atomicals-guide/) to get to know about Atomicals!
76

8-
Workaround: Use `yarn` instead of `npm`
7+
> Multiple templates are covered for setting up Fungible-tokens, NFT collections, Realm & Sub-realm, and Social-FI!
8+
> Check them out at https://github.com/atomicals/atomicals-js/tree/main/templates.
99
10+
**Table Of Contents**
11+
<!-- TOC -->
12+
* [Atomicals Command-line Tool](#atomicals-command-line-tool)
13+
* [Other Atomicals Tools](#other-atomicals-tools)
14+
* [Install](#install)
15+
* [Quick Start](#quick-start)
16+
* [0. Environment File (.env)](#0-environment-file-env)
17+
* [1. Wallet Setup](#1-wallet-setup)
18+
* [2. Explore the CLI](#2-explore-the-cli)
19+
<!-- TOC -->
1020

11-
### Install, Build and Run Tests
21+
### Other Atomicals Tools
1222

13-
## Install
23+
- Atomicals ElectrumX Indexer Server (https://github.com/atomicals/atomicals-electrumx)
1424

15-
```
25+
### Install
26+
27+
Use `yarn` (or `pnpm`) package manager instead of `npm`.
28+
29+
```shell
1630
# Download the GitHub repo:
1731
git clone https://github.com/atomicals/atomicals-js.git
1832

1933
cd atomicals-js
2034

21-
# Build:
22-
# If you don't have yarn & node installed
35+
# Build: If you don't have yarn & node installed
2336
# npm install -g node
2437
# npm install -g yarn
2538

2639
yarn install
2740
yarn run build
2841

29-
#See all commands at:
30-
42+
# See all commands at:
3143
yarn run cli --help
32-
3344
```
3445

35-
### Quick Start - Command Line (CLI)
46+
### Quick Start
3647

37-
First, install packages and build, then follow the steps here to create your first Atomical and query the status. Use `yarn cli`to get a list of all commands available.
48+
First, install packages and build, then follow the steps here to create your first Atomical and query the status.
49+
Use `yarn cli`to get a list of all commands available.
3850

3951
#### 0. Environment File (.env)
4052

41-
The environment file comes with defaults (`.env.example`), but it is highly recommended to install and operate your own ElectrumX server. Web browser communication is possible through the `wss` (secure websockets) interface of ElectrumX.
53+
The environment file comes with defaults (`.env.example`), but it is highly recommended to install and operate your own
54+
ElectrumX server. Web browser communication is possible through the `wss` (secure websockets) interface of ElectrumX.
4255

43-
```
56+
```dotenv
4457
ELECTRUMX_PROXY_BASE_URL=https://ep.your-atomicals-electrumx-host/proxy
4558
46-
// Optional
59+
# Optional
4760
WALLET_PATH=./wallets
4861
WALLET_FILE=wallet.json
4962
50-
// The number of concurrent processes to be used. This should not exceed the number of CPU cores available. If not set, the default behavior is to use all available CPU cores minus one.
63+
# The number of concurrent processes to be used. This should not exceed the number of CPU cores available.
64+
# If not set, the default behavior is to use all available CPU cores minus one.
5165
CONCURRENCY=4
5266
```
5367

54-
5568
#### 1. Wallet Setup
5669

57-
The purpose of the wallet is to create p2tr (pay-to-taproot) spend scripts and to receive change from the transactions made for the various operations. _Do not put more funds than you can afford to lose, as this is still beta!_
70+
The purpose of the wallet is to create p2tr (pay-to-taproot) spend scripts and to receive change from the transactions
71+
made for the various operations.
72+
_Do not put more funds than you can afford to lose, as this is still beta!_
5873

59-
To initialize a new `wallet.json` file that will store your address for receiving change use the `wallet-init` command. Alternatively, you may populate the `wallet.json` manually, ensuring that the address at `m/44'/0'/0'/0/0` equals the address and the derivePath is set correctly.
74+
To initialize a new `wallet.json` file that will store your address for receiving change use the `wallet-init` command.
75+
Alternatively, you may populate the `wallet.json` manually, ensuring that the address at `m/86'/0'/0'/0/0`
76+
equals the address and the `derivePath` is set correctly.
6077

6178
Configure the path in the environment `.env` file to point to your wallet file. defaults to `./wallet.json`
6279

6380
Default:
6481

65-
```
82+
```dotenv
6683
WALLET_PATH=.
6784
WALLET_FILE=wallet.json
6885
```
6986

7087
Update to `wallets/` directory:
7188

72-
```
89+
```dotenv
7390
WALLET_PATH=./wallets
7491
WALLET_FILE=wallet.json
7592
```
7693

7794
Create the wallet:
7895

79-
```
96+
```shell
8097
yarn cli wallet-init
8198

8299
>>>
83100

84101
Wallet created at wallet.json
85102
phrase: maple maple maple maple maple maple maple maple maple maple maple maple
86103
Legacy address (for change): 1FXL2CJ9nAC...u3e9Evdsa2pKrPhkag
87-
Derive Path: m/44'/0'/0'/0/0
104+
Derive Path: m/86'/0'/0'/0/0
88105
WIF: L5Sa65gNR6QsBjqK.....r6o4YzcqNRnJ1p4a6GPxqQQ
89106
------------------------------------------------------
90107
```
91108
92109
#### 2. Explore the CLI
93110
94-
Get all of the commands available:
111+
Get all the commands available:
95112
96-
```
113+
```shell
97114
yarn cli --help
98115
```
99-
100-
101-
## ElectrumX Server RPC Interface
102-
103-
Atomicals ElectrumX (https://github.com/atomicals/atomicals-electrumx)
104-

0 commit comments

Comments
 (0)