Version 1
[yaffs-website] / vendor / drupal / console-en / README.md
diff --git a/vendor/drupal/console-en/README.md b/vendor/drupal/console-en/README.md
new file mode 100644 (file)
index 0000000..43e1e4b
--- /dev/null
@@ -0,0 +1,54 @@
+# drupal-console-en
+
+## Usage
+
+Drupal Console project it's installed per each Drupal 8 website with English language by default.
+
+To install Drupal Console package in other languages check the packages available at [https://packagist.org](https://packagist.org)
+
+
+### Install Drupal Console
+
+To install the appropriate version of Drupal Console project for your drupal installation, run the following composer command
+
+```
+$ composer require drupal/console:~1.0 --prefer-dist --optimize-autoloader
+```
+
+### Install Drupal Console launcher
+
+In order to avoid conflicts between Drupal release and have a Drupal Console version between major and minor releases in Drupal,  a Drupal Console launcher was created. n order to facilitate to load the Drupal Console commands available to each
+Drupal 8 website,
+Following the instruction below you could install the global application for Drupal Console launcher. 
+
+```
+$ curl https://drupalconsole.com/installer -L -o drupal.phar
+# Or 
+$ php -r "readfile('https://drupalconsole.com/installer');" > drupal.phar
+
+$mv drupal.phar /usr/local/bin/drupal
+$ chmod +x /usr/local/bin/drupal
+```
+
+### Contribute
+
+If you want to contribute to this translation, you need to follow this steps
+
+- Fork this repository following this link [https://github.com/hechoendrupal/drupal-console-en#fork-destination-box](https://github.com/hechoendrupal/drupal-console-en#fork-destination-box)
+- Clone your repostory forked in your local machine.
+- Set up upstream
+
+In order to be updated with other contribution you must to setup a connected with main repository using the following git command
+
+```
+$ git remote add upstream git@github.com:hechoendrupal/drupal-console-en.git
+```
+
+To fetch the latest contribution before to start, you must run the next commands
+```
+$ git fetch upstream
+$ git merge upstream/master
+```
+
+N.B: Push your changes to your forked repository in order to create PR per day to avoid any conflicts with other contributors.