3.0

.gitignore

@@ -1 +1,3 @@
 *.svn
+
+/vendor/

README.md

@@ -1,34 +1,114 @@
-sugarcrm-vardef-modifier
+vardef-modifier
 ========
 
-About
----------------------
+# About
 
  * __Author:__ Emil Kilhage
  * __Date Created:__ 2012-04-24
  * __License:__ MIT
 
 See vardefs.example.yml for some syntax references.
 
-Installation
----------------------
+# Installation
 
-# Install in project
+Add the dependency to composer.json:
 
-git submodule add [email protected]:dri-nordic/vardef-modifier.git docroot/custom/include/VardefModifier
+```json
+{
+    "require": {
+        "dri-nordic/vardef-modifier": "~2.0@dev"
+    },
+    "repositories": [
+        {
+            "type": "composer",
+            "url":  "https://packages.dricrm.com/"
+        }
+    ]
+}
+```
 
-# Install in module
+And run:
 
-## Install in custom module
+```bash
+composer install
+```
 
-php docroot/custom/include/VardefModifier/install.php DRI_Invoices -c
+Composer will install the library to your project's `vendor/dri-nordic/vardef-modifier` directory.
 
-## Install in core module
+# Usage
 
-php docroot/custom/include/VardefModifier/install.php Accounts
+Run the help command for full documentation about available commands:
 
-Todo
----------------------
+```bash
+bin/vardef-modifier help
+```
 
- * Make it possible to install as composer dependency
- * Make it possible to export .yml definitions to php files
+## install
+
+Run the help command as the command name as the first parameter for full documentation about the command:
+
+```bash
+bin/vardef-modifier help install
+```
+
+### Install in custom module
+
+```bash
+bin/vardef-modifier install -m DRI_Invoices -c
+```
+
+### Install in core module
+
+```bash
+bin/vardef-modifier install -m Accounts
+```
+
+## dump
+
+### normal usage
+
+```bash
+bin/vardef-modifier dump DRI_Workflows modules/DRI_Workflows/vardefs.yml dri-customer-journey
+```
+
+### use the dump command from outside of Sugar
+
+```bash
+bin/vardef-modifier dump -T ~/www/sugarcrm-7.6.0.0 DRI_Workflows modules/DRI_Workflows/vardefs.yml dri-customer-journey
+```
+
+## migrate
+
+NOT FINISHED
+
+Migrates the target directory to the current version of the library
+
+### List files that needs to be migrated
+
+```bash
+bin/vardef-modifier migrate:find
+```
+
+### Attempt to automatically migrate files
+
+```bash
+bin/vardef-modifier migrate:write
+```
+
+### Attempt to automatically migrate files
+
+```bash
+bin/vardef-modifier migrate:write --force
+```
+
+## setup
+
+NOT FINISHED
+
+Installs the library in the target directory
+
+### List files that needs to be migrated
+
+```bash
+bin/vardef-modifier setup
+```

UPGRADE-2.0.md

@@ -0,0 +1,97 @@
+UPGRADE FROM 1.x to 2.0
+=======================
+
+### Composer support
+
+In v2.0 the VardefModifier can be included as a composer dependency
+
+   ```json
+    {
+        "require": {
+            "dri-nordic/vardef-modifier": "~2.0"
+        },
+        "repositories": [
+            {
+                "type": "composer",
+                "url":  "https://packages.dricrm.com/"
+            }
+        ]
+    }
+   ```
+
+### Submodule no longer supported
+
+If you have these situations where you can not include the library as a composer dependency you should rather use this tool from outside of the project and dump the vardef definitions trough the `dump` command
+
+If you still need to include the library as a submodule, please make sure that the `1.2` branch is used and not `master` or any `2.0` branch as this may break existing code.
+
+### Namespace
+
+The VardefModifier class has been moved into its own namespace and is now referenced like this
+
+    \DRI\SugarCRM\VardefModifier\VardefModifier
+
+### Commands
+
+All commands previously accessed in the root of the repo has been moved into using symfony's console framework
+
+The old install command was used like this:
+
+   ```bash
+   install.php Accounts Contacts
+   install.php DRI_Config --core
+   ```
+
+The new command is used like this:
+
+   ```bash
+   bin/vardef-modifier install -m Accounts -m Contacts
+   bin/vardef-modifier install -m DRI_Config --core
+   ```
+
+Here is the full help of the new install command, run this command your self for the latest help, also look at the other documentation for a more complete overview of this
+
+   ```bash
+
+    bin/vardef-modifier help install
+
+    Usage:
+      install [options]
+
+    Options:
+      -F, --force
+      -C, --core
+      -D, --dry
+      -Y, --only-yml
+      -P, --only-php
+      -m, --module=MODULE     (multiple values allowed)
+      -N, --name[=NAME]
+      -T, --target[=TARGET]  target sugar path that should be used as context, defaults to the current working directory
+      -h, --help             Display this help message
+      -q, --quiet            Do not output any message
+      -V, --version          Display this application version
+          --ansi             Force ANSI output
+          --no-ansi          Disable ANSI output
+      -n, --no-interaction   Do not ask any interactive question
+      -v|vv|vvv, --verbose   Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
+
+    Help:
+     Installs an empty yaml vardef addition for a module
+
+   ```
+
+A few new commands has also been added, to see what is available run:
+
+    bin/vardef-modifier help
+
+### Migration
+
+Use the migration command to find and reinstall the vardef inclusions of the library
+
+#### List files that needs to be migrated
+
+    bin/vardef-modifier migrate --find
+
+#### Attempt to automatically migrate files
+
+    bin/vardef-modifier migrate --write