chore(xod-cli): fix readme generation

This commit is contained in:
Sergey Korolev
2018-12-27 13:40:02 +03:00
parent 799593b951
commit 7891fb74ef
3 changed files with 4 additions and 27 deletions

1
.prettierignore Normal file
View File

@@ -0,0 +1 @@
packages/xod-cli/README.md

View File

@@ -9,30 +9,10 @@ Basically its a collection of thin wrappers around NodeJS APIs available v
`xodc` uses subcommands like `git` does to perform various functions. The subcommands handling could be found in `src/commands/*.js`.
<!-- toc -->
* [xod-cli](#xod-cli)
* [Usage](#usage)
* [Flags, aliases, environment variables](#flags-aliases-environment-variables)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g xod-cli
$ xodc COMMAND
running command...
$ xodc (-v|--version|version)
xod-cli/0.25.0 linux-x64 node-v10.13.0
$ xodc --help [COMMAND]
USAGE
$ xodc COMMAND
...
```
<!-- usagestop -->
<!-- tocstop -->
# Flags, aliases, environment variables
@@ -54,7 +34,6 @@ Almost any flag can be replaced with the appropriate environment variable. For e
# Commands
<!-- commands -->
* [`xodc autocomplete [SHELL]`](#xodc-autocomplete-shell)
* [`xodc boards [options]`](#xodc-boards-options)
* [`xodc compile [options] [entrypoint]`](#xodc-compile-options-entrypoint)
@@ -175,7 +154,7 @@ USAGE
$ xodc install:arch [fqbn]
ARGUMENTS
FQBN Board FQBN. `arduino:sam` for example.
FQBN Board FQBN. `arduino:sam` for example. See `xodc boards` list for the full list.
OPTIONS
-V, --version show CLI version
@@ -374,5 +353,4 @@ EXAMPLE
```
_See code: [src/commands/upload.js](https://github.com/xodio/xod/blob/master/packages/xod-cli/src/commands/upload.js)_
<!-- commandsstop -->

View File

@@ -86,8 +86,6 @@
"build": "yarn run build:bundle && yarn run build:src",
"dev": "yarn run build --watch",
"postpack": "rm -f oclif.manifest.json",
"prepack": "yarn run build && oclif-dev manifest && oclif-dev readme",
"test-func": "BABEL_DISABLE_CACHE=1 mocha --opts test-func/mocha.opts test-func/**/*.spec.js",
"version": "oclif-dev readme && git add README.md"
"test-func": "BABEL_DISABLE_CACHE=1 mocha --opts test-func/mocha.opts test-func/**/*.spec.js"
}
}