Skip to content

Commit

Permalink
Merge pull request #715 from axone-protocol/docs/simplify-readme
Browse files Browse the repository at this point in the history
docs: simplify readme
  • Loading branch information
amimart committed Aug 2, 2024
2 parents 67e3e71 + caaca26 commit cb3b861
Showing 1 changed file with 32 additions and 44 deletions.
76 changes: 32 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,58 +59,24 @@ All releases can be found [here](https://github.com/axone-protocol/axoned/releas
`axoned` follows the [Semantic Versioning 2.0.0](https://semver.org/) to determine when and how the version changes, and
we also apply the philosophical principles of [release early - release often](https://en.wikipedia.org/wiki/Release_early,_release_often).

## Docker image
## Install

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

```bash
docker pull axone-protocol/axoned:latest
```

### Get the documentation

```bash
docker run axone-protocol/axoned:latest --help
```

### Query a running network

Example:

```bash
API_URL=https://api.devnet.okp4.network:443/rpc
WALLET=okp41pmkq300lrngpkeprygfrtag0xpgp9z92c7eskm

docker run axone-protocol/axoned:latest query bank balances $WALLET --chain-id axone-devnet-1 --node $API_URL
```

### Create a wallet

```bash
docker run -v $(pwd)/home:/home axone-protocol/axoned:latest keys add my-wallet --keyring-backend test --home /home
```sh
curl https://i.jpillora.com/axone-protocol/axoned! | bash
```

### Start a node

Everything you need to start a node and more is explained here: <https://docs.axone.xyz/docs/nodes/run-node>
### From source

```bash
MONIKER=node-in-my-name
CHAIN_ID=localnet-axone-1
docker run -v $(pwd)/home:/home axone-protocol/axoned:latest init $MONIKER --chain-id $CHAIN_ID --home /home
```sh
make install
```

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/>

#### Join a running network

Set `persistent_peers` in `config/config.toml` file.
### Using docker

#### Then start the node

```bash
docker run -v $(pwd)/home:/home axone-protocol/axoned:latest start --home /home
```sh
docker run -ti --rm axoneprotocol/axoned --help
```

## Developing & contributing
Expand Down Expand Up @@ -189,6 +155,28 @@ make build

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

### Run a local network

To initialize a local network configuration, invoke the goal `chain-init` of the `Makefile`:

```sh
make chain-init
```

The node home directory will be generated under the folder `target/deployment/localnet`. The configuration contains a single validator node.

To start the network, invoke the goal `chain-start` of the `Makefile`:

```sh
make chain-start
```

A wallet is preconfigured with some tokens, you can use it as follows:

```sh
axoned --home target/deployment/localnet tx bank send validator [to_address] [amount]
```

## Bug reports & feature requests

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

0 comments on commit cb3b861

Please sign in to comment.