Skip to content

Commit fa20ac6

Browse files
pinheadmzwillcl-ark
authored andcommitted
update readme with new syntax
1 parent 5f72f10 commit fa20ac6

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -111,25 +111,25 @@ pip install -e .
111111

112112
## Running
113113

114-
Warnet runs a daemon called `warnetd` which can be used to manage multiple warnets.
115-
`warnetd` will by default log to a file `$XDG_STATE_HOME/warnet/warnet.log` if the `$XDG_STATE_HOME` environment variable is set, otherwise it will use `$HOME/.warnet/warnet.log`.
114+
Warnet runs a daemon which can be used to manage multiple warnets.
115+
`warnet` will by default log to a file `$XDG_STATE_HOME/warnet/warnet.log` if the `$XDG_STATE_HOME` environment variable is set, otherwise it will use `$HOME/.warnet/warnet.log`.
116116

117-
To start `warnetd` with your venv activated simply run:
117+
To start `warnet` in the foreground with your venv activated simply run:
118118

119119
```bash
120-
warnetd
120+
warnet
121121
```
122122

123123
> [!NOTE]
124-
> `warnetd` also accepts a `--no-debug` option which prevents daemonization
124+
> `warnetd` also accepts a `--daemon` option which runs the process in the background.
125125
126-
Once `warnetd` is running it can be interacted with using the cli tool `warcli`.
127-
Run `warnet --help` to see a list of possible commands.
126+
Run `warnet --help` to see a list of options.
128127

129-
All `warnet` commands accept a `--network` option, which allows you to specify the warnet you want to control.
128+
Once `warnet` is running it can be interacted with using the cli tool `warcli`.
129+
All `warcli` commands accept a `--network` option, which allows you to specify the warnet you want to control.
130130
This is set by default to `--network="warnet"` to simplify default operation.
131131

132-
To start an example warnet, with your venv active, run the following command to use the default graph and network:
132+
To start an example warnet, with your venv active and the server running, run the following command to use the default graph and network:
133133

134134
```bash
135135
warcli start
@@ -147,7 +147,7 @@ warcli help networks
147147

148148
Each container is a node as described in the graph, along with various data exporters and a demo grafana dashboard.
149149

150-
The commands listed in `warnet --help` can then be used to control and query the nodes.
150+
The commands listed in `warcli help` can then be used to control and query the nodes.
151151

152152
### Run scenarios on a network
153153

@@ -163,7 +163,7 @@ To see available scenarios (loaded from the default directory):
163163
warcli scenarios list
164164
```
165165

166-
Once a scenarios is selected it can be run with `warnet scenarios run <scenario_name> [--network=warnet]`, e.g.:
166+
Once a scenarios is selected it can be run with `warcli scenarios run <scenario_name> [--network=warnet]`, e.g.:
167167

168168
```bash
169169
# Command one node to generate a wallet and fill 100 blocks with 100 txs each
@@ -177,7 +177,7 @@ This will run the run the scenario in the background until it exits or is killed
177177
Currently the warnet can be stopped, but **not** stopped, persisted and continued.
178178
Persisting the warnet during a stoppage is WIP.
179179

180-
To stop the warnet, and warnetd daemon:
180+
To stop the warnet server:
181181

182182
```bash
183183
# stop but retain containers

0 commit comments

Comments
 (0)