Skip to content

Commit

Permalink
Merge pull request #8 from potatodepaulo/readme
Browse files Browse the repository at this point in the history
clean up README and package.json for SEO
  • Loading branch information
behaviary committed Mar 23, 2019
2 parents c5a2be8 + b245791 commit 36bb065
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 11 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Near command line interface
# NEAR command line interface

The [NEAR](https://near.ai/npm) protocol library as CLI tool.
More documentation [here](https://near.ai/readme)

## Installation
```
Expand All @@ -7,15 +10,17 @@ npm install -g near-shell

## Usage
In command line, from directory with your project:
```
```Bash
near <command>
```

### Commands:
near create_account: create a developer account\
near build: build your smart contract\
near deploy: deploy your smart contract

```Bash
near create_account # create a developer account
near build # build your smart contract
near deploy # deploy your smart contract
```
### Options:
--help: Show help [boolean] \
--version: Show version number [boolean]
| Option | Description | Type |
| ------------- |:-------------------:| :---------|
| --help | Show help | [boolean] |
| --version | Show version number | [boolean] |
12 changes: 10 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"type": "git",
"url": "git+https://github.com/nearprotocol/near-shell.git"
},
"author": "",
"author": "Jane Degtiareva",
"license": "MIT",
"bugs": {
"url": "https://github.com/nearprotocol/near-shell/issues"
Expand All @@ -33,5 +33,13 @@
"rimraf": "^2.6.3",
"run-sequence": "^2.2.1",
"yargs": "^13.2.1"
}
},
"keywords": [
"blockchain",
"crypto",
"dapps",
"distributed",
"applications",
"distributed applications"
]
}

0 comments on commit 36bb065

Please sign in to comment.