Skip to content

Commit 5666713

Browse files
committed
feat(docs): Add User's guide
1 parent a6eedca commit 5666713

File tree

10 files changed

+2616
-3
lines changed

10 files changed

+2616
-3
lines changed

.markdownlint.yml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,19 @@ line-length:
1010
# Line length checking is not strict by default.
1111
strict: true
1212
line_length: 80
13-
# Allow longer lines for code blocks.
14-
code_block_line_length: 100
13+
# Code blocks for examples are imported directly from the command output
14+
# and do not have sensible max line length.
15+
code_blocks: false
16+
17+
# Front matter title (shown in the menu and doccards) may differ from the one
18+
# on the actual page.
19+
single-title:
20+
front_matter_title: ""
21+
22+
# Docusaurus uses custom {#some-title} syntax to define fragments (anchors), see:
23+
# https://docusaurus.io/docs/next/markdown-features/toc#heading-ids
24+
# Unfortunately, it is not compatible with the markdown linter yet.
25+
link-fragments: false
1526

1627
# Do not always require language specifiers with fenced code blocks since they
1728
# are not part of the Markdown spec.

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ in your `$PATH`.
3131
*NOTE: The rest of the README assumes the `oasis` binary is somewhere in your
3232
`$PATH`.*
3333

34-
## Running
34+
## Quickstart
3535

3636
You can interact with the Oasis CLI by invoking it from the command line as
3737
follows:
@@ -82,6 +82,12 @@ To show the account's balance on the default network/ParaTime, run:
8282
oasis account show
8383
```
8484

85+
Account command also allows you to transfer tokens, deposit or withdraw to and
86+
from ParaTimes, delegate your assets to validators etc.
87+
88+
Check out the user's guide in [docs/README.md] and various examples of CLI
89+
usage in the `examples` folder to learn more.
90+
8591
## Configuration
8692

8793
All configuration is stored in the `$XDG_CONFIG_HOME/oasis` directory (defaults

docs/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Oasis CLI
2+
3+
Oasis command-line interface (CLI) is a powerful all-in-one tool for
4+
interacting with the Oasis Network. You can download the latest release
5+
binaries from the [GitHub repository].
6+
7+
It boasts a number of handy features:
8+
9+
- Flexible setup:
10+
- supports Mainnet, Testnet, Localnet or any other Oasis network deployment
11+
- consensus layer configuration with arbitrary token
12+
- configuration of custom ParaTimes with arbitrary token
13+
- connecting to remote (via TCP/IP) or local (Unix socket) Oasis node
14+
instance
15+
- Powerful wallet features:
16+
- standard token operations (transfers, allowances, deposits, withdrawals and
17+
balance queries)
18+
- file-based wallet with password protection
19+
- full Ledger hardware wallet support
20+
- address book
21+
- generation, signing and submitting transactions in non-interactive mode
22+
- offline transaction generation for air-gapped machines
23+
- transaction encryption with X25519-Deoxys-II envelope
24+
- Ed25519 and Ethereum-compatible Secp256k1 encryption schemes
25+
- raw, BIP-44, ADR-8 and Ledger's legacy derivation paths
26+
- Developer and devops features:
27+
- Oasis node inspection and healthchecks
28+
- official testing accounts for Oasis Localnet, test runners and debugging
29+
- WebAssembly smart contract code deployment, instantiation, management and
30+
calls
31+
- debugging tools for deployed WebAssembly contracts
32+
33+
[GitHub repository]: https://github.com/oasisprotocol/cli/releases

0 commit comments

Comments
 (0)