Skip to content

Commit cb3b861

Browse files
authored
Merge pull request #715 from axone-protocol/docs/simplify-readme
docs: simplify readme
2 parents 67e3e71 + caaca26 commit cb3b861

File tree

1 file changed

+32
-44
lines changed

1 file changed

+32
-44
lines changed

README.md

Lines changed: 32 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -59,58 +59,24 @@ All releases can be found [here](https://github.com/axone-protocol/axoned/releas
5959
`axoned` follows the [Semantic Versioning 2.0.0](https://semver.org/) to determine when and how the version changes, and
6060
we also apply the philosophical principles of [release early - release often](https://en.wikipedia.org/wiki/Release_early,_release_often).
6161

62-
## Docker image
62+
## Install
6363

64-
For a quick start, a docker image is officially available on [Docker hub](https://hub.docker.com/r/axone-protocol/axoned).
64+
### From release
6565

66-
```bash
67-
docker pull axone-protocol/axoned:latest
68-
```
69-
70-
### Get the documentation
71-
72-
```bash
73-
docker run axone-protocol/axoned:latest --help
74-
```
75-
76-
### Query a running network
77-
78-
Example:
79-
80-
```bash
81-
API_URL=https://api.devnet.okp4.network:443/rpc
82-
WALLET=okp41pmkq300lrngpkeprygfrtag0xpgp9z92c7eskm
83-
84-
docker run axone-protocol/axoned:latest query bank balances $WALLET --chain-id axone-devnet-1 --node $API_URL
85-
```
86-
87-
### Create a wallet
88-
89-
```bash
90-
docker run -v $(pwd)/home:/home axone-protocol/axoned:latest keys add my-wallet --keyring-backend test --home /home
66+
```sh
67+
curl https://i.jpillora.com/axone-protocol/axoned! | bash
9168
```
9269

93-
### Start a node
94-
95-
Everything you need to start a node and more is explained here: <https://docs.axone.xyz/docs/nodes/run-node>
70+
### From source
9671

97-
```bash
98-
MONIKER=node-in-my-name
99-
CHAIN_ID=localnet-axone-1
100-
101-
docker run -v $(pwd)/home:/home axone-protocol/axoned:latest init $MONIKER --chain-id $CHAIN_ID --home /home
72+
```sh
73+
make install
10274
```
10375

104-
This will create a home folder, you can then update the `config/genesis.json` with one of this ones : <https://github.com/axone-protocol/axoned/tree/main/chains/>
105-
106-
#### Join a running network
107-
108-
Set `persistent_peers` in `config/config.toml` file.
76+
### Using docker
10977

110-
#### Then start the node
111-
112-
```bash
113-
docker run -v $(pwd)/home:/home axone-protocol/axoned:latest start --home /home
78+
```sh
79+
docker run -ti --rm axoneprotocol/axoned --help
11480
```
11581

11682
## Developing & contributing
@@ -189,6 +155,28 @@ make build
189155

190156
The binary will be generated under the folder `target/dist`.
191157

158+
### Run a local network
159+
160+
To initialize a local network configuration, invoke the goal `chain-init` of the `Makefile`:
161+
162+
```sh
163+
make chain-init
164+
```
165+
166+
The node home directory will be generated under the folder `target/deployment/localnet`. The configuration contains a single validator node.
167+
168+
To start the network, invoke the goal `chain-start` of the `Makefile`:
169+
170+
```sh
171+
make chain-start
172+
```
173+
174+
A wallet is preconfigured with some tokens, you can use it as follows:
175+
176+
```sh
177+
axoned --home target/deployment/localnet tx bank send validator [to_address] [amount]
178+
```
179+
192180
## Bug reports & feature requests
193181

194182
If you notice anything not behaving how you expected, if you would like to make a suggestion or would like

0 commit comments

Comments
 (0)