ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-03-23 12:35:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README to link to the full CLI command documentation

Browse Source 
Also update description to match package.json & repo, and remove
quickstart (since it's unstable at the moment).

Change-Type: patch
This commit is contained in:
Tim Perry 2017-08-22 20:01:53 +02:00
parent 0a3123a9cf
commit cfdd4d3d69
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,7 +1,7 @@
Resin CLI
=========
> The official Resin CLI tool.
> The official resin.io CLI tool.
[![npm version](https://badge.fury.io/js/resin-cli.svg)](http://badge.fury.io/js/resin-cli)
[![dependencies](https://david-dm.org/resin-io/resin-cli.svg)](https://david-dm.org/resin-io/resin-cli)
@ -32,7 +32,7 @@ If you still want to use `cmd.exe` you will have to use a package manager like M
Getting Started
---------------
### Installing
### Install
This might require elevated privileges in some environments.
@ -40,17 +40,20 @@ This might require elevated privileges in some environments.
$ npm install --global --production resin-cli
```
### List available commands
### Login
```sh
$ resin help
$ resin login
```
### Run the quickstart wizard
_(Typically useful, but not strictly required for all commands)_
```sh
$ resin quickstart
```
### Run commands
Take a look at the full command documentation at [https://docs.resin.io/tools/cli/](https://docs.resin.io/tools/cli/#table-of-contents
), or by running `resin help`.
---
Plugins
-------