Skip to content
This repository was archived by the owner on Oct 23, 2022. It is now read-only.

Commit fa6fc75

Browse files
committed
doc(http): explain cmd line options in tutorial
1 parent 7b79d5d commit fa6fc75

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

http/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,10 @@ You can initialise the directory with:
3838
cargo run -p ipfs-http -- init --profile test --bits 2048
3939
```
4040

41-
The output should return a peer id and confirm the path of the newly
42-
initialised node is either the default or the `IPFS_PATH`.
41+
The `--profile` option allows the user to use a set of defaults. Currently
42+
only `test` is supported. The `--bits` option specifies the length of the RSA
43+
keys to be used. The output should return a peer id and confirm the path of the
44+
newly initialised node is either the default or the `IPFS_PATH`.
4345

4446
The `.rust-ipfs` directory now contains a configuration file, `config`:
4547

0 commit comments

Comments
 (0)