Documentation fixes & improvements
This commit is contained in:
parent
216945ef0b
commit
b38faa7652
12
README.md
12
README.md
|
@ -8,9 +8,8 @@ development, so any help is welcomed! Feel free to contribute.
|
|||
|
||||
## Requirements
|
||||
|
||||
* Node.js >= 14.0
|
||||
* Git
|
||||
* Docker (Local server)
|
||||
* Docker (Optional, used to manage local server)
|
||||
|
||||
## Installation
|
||||
|
||||
|
@ -33,7 +32,8 @@ $ npx myvc <command>
|
|||
Execute *myvc* with the desired command.
|
||||
|
||||
```text
|
||||
$ [npx] myvc [-w|--workspace <string>] [-r|--remote <string>] [-d|--debug] [-h|--help] <command> [<args>]
|
||||
$ [npx] myvc [-w|--workspace <string>] [-r|--remote <string>] [-d|--debug]
|
||||
[-h|--help] <command> [<args>]
|
||||
```
|
||||
|
||||
The default workspace directory is the current working directory and unless
|
||||
|
@ -95,7 +95,7 @@ From now on, you can use the project as if it were a standard git repository
|
|||
desired remote.
|
||||
|
||||
```text
|
||||
$ myvc push [<remote>] [--save-commit]
|
||||
$ myvc push [<remote>] [--commit]
|
||||
```
|
||||
|
||||
### Routines
|
||||
|
@ -148,7 +148,6 @@ You can create your local fixture and structure files.
|
|||
* *dump/structure.sql*
|
||||
* *dump/fixtures.sql*
|
||||
|
||||
|
||||
## Versioning commands
|
||||
|
||||
### init
|
||||
|
@ -194,6 +193,9 @@ name mixing a color with a plant name.
|
|||
$ myvc version [<name>] [-o|--hold]
|
||||
```
|
||||
|
||||
By default it also cleans all already applied versions older than
|
||||
*maxOldVersions*, you can provide de *--hold* option to prevent this behavior.
|
||||
|
||||
## Local server commands
|
||||
|
||||
### dump
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "myvc",
|
||||
"version": "1.4.2",
|
||||
"version": "1.4.3",
|
||||
"author": "Verdnatura Levante SL",
|
||||
"description": "MySQL Version Control",
|
||||
"license": "GPL-3.0",
|
||||
|
|
Loading…
Reference in New Issue