Skip to content

Commit

Permalink
Merge branch 'main' into update_near_abi
Browse files Browse the repository at this point in the history
  • Loading branch information
dj8yfo authored Nov 10, 2023
2 parents 33b627b + 21214db commit 0e54b33
Showing 1 changed file with 41 additions and 4 deletions.
45 changes: 41 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,31 @@

## Installation

From crates.io:
### Install prebuilt binaries via shell script (Linux, macOS)

```sh
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/near/cargo-near/releases/latest/download/cargo-near-installer.sh | sh
```

### Install prebuilt binaries via powershell script (Windows)

```sh
irm https://github.com/near/cargo-near/releases/latest/download/cargo-near-installer.ps1 | iex
```

### Install prebuilt binaries into your npm project

```sh
npm install cargo-near
```

### Compile latest released version from source code

```console
$ cargo install cargo-near
cargo install cargo-near
```

To install from source:
### Compile latest development version from source code

```console
$ git clone https://github.com/near/cargo-near
Expand All @@ -37,7 +55,13 @@ $ cargo install --path cargo-near

## Usage

See `cargo near --help` for a complete list of available commands. Help is also available for each individual command with a `--help` flag, e.g. `cargo near build --help`.
See `cargo near --help` for a complete list of available commands or run `cargo near` to dive into interactive mode. Help is also available for each individual command with a `--help` flag, e.g. `cargo near build --help`.

```console
cargo near
```

Starts interactive mode that will allow to explore all the available commands.

```console
cargo near build
Expand All @@ -53,6 +77,19 @@ cargo near abi

Generates NEAR smart contract's [ABI](https://github.com/near/abi) (while in the directory containing contract's Cargo.toml).

```console
cargo near create-dev-account
```

Guides you through creation of a new NEAR account on [testnet](https://explorer.testnet.near.org).

```console
cargo near deploy
```

Builds the smart contract (equivalent to `cargo near build`) and guides you to deploy it to the blockchain.


## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
Expand Down

0 comments on commit 0e54b33

Please sign in to comment.