From 8d825c4284123c7b8c30fb8c0ba6c6f8685eb621 Mon Sep 17 00:00:00 2001 From: Juan Ferrer Toribio Date: Mon, 16 Nov 2020 01:58:27 +0100 Subject: [PATCH] Documentation updated, keywords --- LICENSE | 2 +- README.md | 31 +++++++++++++++++++++---------- package.json | 14 +++++++++----- 3 files changed, 31 insertions(+), 16 deletions(-) diff --git a/LICENSE b/LICENSE index 3d994d0..5e558e2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (C) 2018 - Verdnatura Levante S.L. +Copyright (C) 2020 - Verdnatura Levante S.L. This package is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/README.md b/README.md index 259591f..2efeb97 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ Required applications. It's recommended to install the package globally. ```text # npm install -g myvc +$ myvc [action] ``` You can also install locally and use the *npx* command to execute it. @@ -50,32 +51,42 @@ Each action can have its own specific commandline options. ## Basic information -First of of you have to import *structure.sql* into your database. This script +First of all you have to import *structure.sql* into your database. This script includes the tables where MyVC stores information about applied versions. -Then, create *myvc.config.json* main configuration file at the root of your -project folder, this file should include the project codename and schemas/tables -wich are exported when you use *structure*, *fixtures* or *routines* actions. -you have an example of a configuration file in the root folder of this project. +Create *myvc.config.json* main configuration file at the root of your project +folder, this file should include the project codename and schemas/tables wich +are exported when you use *structure*, *fixtures* or *routines* actions. You +have an example of a configuration file in the root folder of this project. -Also, create database connection configuration files for each environment at -main project folder using standard MySQL *.ini*. The predefined environment -names are *production* and *testing*. +### Environments + +Create database connection configuration files for each environment at main +project folder using standard MySQL *.ini*. The predefined environment names +are *production* and *testing*. ```text db.[environment].ini ``` +### Dumps + Structure and fixture dumps will be created inside *dump* folder. * *structure.sql* * *fixtures.sql* + +### Local + +You can also create your local fixture and structure files inside *dump* folder. + +* *structure.local.sql* * *fixtures.local.sql* ### Routines Routines should be placed inside *routines* folder. All objects that have -PL/SQL code are considered routines. It includes functions, triggers, views and -events with the following structure. +PL/SQL code are considered routines. It includes events, functions, procedures, +triggers and views with the following structure. ```text routines `- schema diff --git a/package.json b/package.json index 7a3c17d..5644078 100644 --- a/package.json +++ b/package.json @@ -1,12 +1,10 @@ { "name": "myvc", - "version": "1.0.5", + "version": "1.0.6", "author": "Verdnatura Levante SL", "description": "MySQL Version Control", "license": "GPL-3.0", - "bin": { - "myvc": "myvc.js" - }, + "bin": "myvc.js", "repository": { "type": "git", "url": "https://github.com/verdnatura/myvc.git" @@ -26,5 +24,11 @@ "devDependencies": {}, "scripts": { "test": "echo \"Error: no test specified\" && exit 1" - } + }, + "keywords": [ + "mysql", + "mariadb", + "version", + "control" + ] }