Merge pull request #10 in CFA/coding-guidelines from to_github to master

* commit '445b6a51a030570ad2057982a975219f611c3694':
  changed email addresses to the new format
  Added career link
  Updated readme title
  Updated readme.md: Use new command names
  - Renamed repository - Updated composer dependencies

Author: Maximilian Grosch

README.md

@@ -1,12 +1,11 @@
-# Flyeralarm Coding Guidelines
+# Flyeralarm PHP Coding Guideline Validator
 
 
-This repository contains the ruleset for the PHP code we develop at flyeralarm. 
+This repository contains the ruleset for the PHP code we develop at [FLYERALARM](https://flyeralarm.com). 
 It mostly consists of PSR-2 with some custom additions. The rules are enforced with the help of squizlabs/PHP_CodeSniffer
 
 
-How-To work within *this* project
-------
+## How-To work within *this* project
 To prepare run command:
 ```
 make
@@ -18,40 +17,38 @@ make test
 ```
 
 
-Embed into *your* project
-------------------------
+## Embed into *your* project
 
 Add as composer dev dependency:
 ```
-composer config repositories.flyeralarm/coding-guidelines git ssh://git@stash.flyeralarm:7999/cfa/coding-guidelines.git
-composer require --dev flyeralarm/coding-guidelines
+composer config repositories.flyeralarm/php-code-validator git https://github.com/flyeralarm/php-code-validator.git
+composer require --dev flyeralarm/php-code-validator
 ```
 
 Embed code sniffer in your Makefile. To intend please use tabs instead of spaces. \
-_Usage:_ vendor/bin/fa-coding-guideline-validator <folder-to-test-one> <folder-to-test-two> <...>
+_Usage:_ vendor/bin/php-code-validator <folder-to-test-one> <folder-to-test-two> <...>
+
+Example Makefile:
 ```
 test:
-	vendor/bin/fa-coding-guideline-validator src/ tests/
+	vendor/bin/php-code-validator src/ tests/
 ```
 
 
-Update to latest stable
------------------------
+### Update to latest stable
 
 ```
-composer update flyeralarm/coding-guidelines
+composer update flyeralarm/php-code-validator
 ```
 
 
-Run sniffer within your project
--------------------------------
+### Run sniffer
 ```
 make test
 ```
 
 
-Use within PHPStorm
--------------------
+## Use within PHPStorm
 1) Ensure the path to PHP Code Sniffer is configured - [open configuration manual](https://confluence.jetbrains.com/display/PhpStorm/PHP+Code+Sniffer+in+PhpStorm#PHPCodeSnifferinPhpStorm-1.1.SpecifyingthepathtoPHPCodeSniffer) 
 2) Open settings: \
    Mac: `PhpStorm` > `Preferences` > `Editor` > `Inspections` > `PHP` \
@@ -61,3 +58,6 @@ Use within PHPStorm
 5) Choose "Custom" for „Coding standard:“ and click on `...` on the right hand side
 6) Select Path to ruleset. This would be something like <YOUR_APP_ROOT>/vendor/flyeralarm/coding-guidelines/ruleset.xml
 7) Confirm dialogs by pressing `ok`
+
+
+On a side note: [We are searching for talented people to join our various teams of developers in multiple locations](https://karriere.flyeralarm.com/jobs)

bin/fa-coding-guideline-validator renamed to bin/php-code-validator

@@ -1,23 +1,23 @@
 {
-    "name": "flyeralarm/coding-guidelines",
+    "name": "flyeralarm/php-code-validator",
     "description": "A custom coding standard for flyeralarm",
     "type": "config",
     "license": "proprietary",
     "authors": [
         {
             "name": "Daniel Müller",
-            "email": "d.mueller@flyeralarm.de"
+            "email": "daniel.mueller@flyeralarm.com"
         },
         {
             "name": "Maximilian Grosch",
-            "email": "m.grosch@flyeralarm.de"
+            "email": "maximilian.grosch@flyeralarm.com"
         }
     ],
     "minimum-stability": "stable",
     "require": {
         "squizlabs/php_codesniffer": "^3.0"
     },
     "bin": [
-        "bin/fa-coding-guideline-validator"
+        "bin/php-code-validator"
     ]
 }