diff --git a/README.md b/README.md new file mode 100644 index 0000000..feb4895 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# DiffCS + +A tool to perform PSR-2 check into your pull requests on Github. + +## How To Install + +Through **Composer**: + +``` +composer global require "marcelsud/diffcs":"dev-master" +``` + +We suggest you to use `global` requirement, so you can use for all projects. + +Or cloning this project: + +``` +git clone git@github.com:marcelsud/diffcs.git +``` + +Once it's done, go to the root folder and execute: + +``` +composer install +``` + +Then, run the following command to use this tool through your `bin` folder: + +``` +sudo ln -nfs ~/.composer/vendor/bin/diffcs /usr/local/bin/diffcs +``` + +## How To Use + +### For public repositories: + +Run the following command: `diffcs / `, where: + +- `` is the corporation/user behind the project; +- `` is the project name on Github; +- `` is the pull request id, created by Github. + +**Example**: + +``` +diffcs symfony/symfony 13342 +``` + +### For private repositories: + +Execute following command: `diffcs / --github-user=`, where: + +- `` is your Github username. + +**Example**: + +``` +diffcs symfony/symfony 13342 --github-user=seuusuario +``` + +Once you run this command, provide your Github password. **The password is only required to authenticate your credentials into the private repository.** + +![Image](https://41.media.tumblr.com/df1e6041b827dc067d1c4c16ffb3df05/tumblr_nldnzr0w011sr73oio1_1280.png)