Skip to content

Commit

Permalink
master: change readme
Browse files Browse the repository at this point in the history
  • Loading branch information
FroVolod committed Jun 4, 2021
1 parent 4cee9ab commit 7c4632f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 35 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ on:
workflow_dispatch:
# pull_request:
# branches: [master]
push:
# push:
#Enable when testing release infrastructure on a branch.
branches: [master]
# branches: [master]
jobs:
create-release:
name: create-release
Expand Down
43 changes: 10 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,14 @@ near-cli is a command line utility for working with the Near Protocol blockchain

### README.md

* en [English](docs/README.en.md)
* ru [Русский](docs/README.ru.md)
#### [README in English](docs/README.en.md)
* [Usage](docs/README.en.md#usage)
* [User Guide](docs/README.en.md#user-guide)
* [Installation](docs/README.en.md#installation)
* [Building](docs/README.en.md#building)


### Usage

In general, it is difficult for a beginner to immediately understand how commands work.
For example, I consider having the following command to do a transfer:
```txt
near-cli transfer near \
network testnet \
sender 'volodymyr.testnet' \
receiver '21.volodymyr.testnet' \
amount '1 NEAR' \
sign-with-keychain \
send
```
This is the complete version of the command. The result of this command will be as follows:
```txt
--- Success: ---
FinalExecutionOutcome {
status: SuccessValue(``),
...
}
```
Typing this or another command manually, you can make a mistake or forget the sequence of the command.
It is not a problem. `--help` will tell you how to build a command properly.
However, using near-cli, you can press _Enter_ anywhere in the command line and the interactive mode of the program will continue to compose the command from the place where you finished entering the necessary parameters.

<details><summary><i>Demonstration of the utility with a partially recruited command</i></summary>
<a href="https://asciinema.org/a/tdNu6qoDKUzFH6ZCsfADHoqOP?autoplay=1&t=1&speed=2">
<img src="https://asciinema.org/a/tdNu6qoDKUzFH6ZCsfADHoqOP.png" width="836"/>
</a>
</details>
#### [README на Русском (in Russian)](docs/README.ru.md)
* [Применение](docs/README.ru.md#применение)
* [Инструкция](docs/README.ru.md#инструкция)
* [Установка](docs/README.ru.md#установка)
* [Сборка](docs/README.ru.md#сборка)

0 comments on commit 7c4632f

Please sign in to comment.