@@ -85,39 +85,69 @@ The following packages are suggested:
8585
8686## Usage
8787
88- This is a simple metapackage, but still can be used in different ways.
88+ This is a simple metapackage which can be used in two different ways; globally installed or on a per project basis .
8989
90- #### Global install
90+ Both methods have their pros (+) and cons (-).
9191
92- This is by far the easiest and most convenient method. Simply having all the tools available system wide.
92+ ** Global installation** :
93+ * \+ All tools are present anywhere on your system
94+ * \+ Can be used on any codebase, even the ones that don't use Composer.
95+ * \- You'll have to update manually, since it's not a project, versioning is not managed.
96+
97+ * Per project installation* :
98+ * \+ Versioning (update/installation) is provided in the project
99+ * \- Tools not available system wide. You'll need to execute them from a specific path.
100+
101+ These methods are not mutual exclusive. You can have your global installed version, which can be used anywhere, but
102+ still use the one provided in a project.
103+
104+ ## Installation
105+
106+ ### Global installation
93107
94108The following script will install a system wide Composer for you, including the QA tools.
95109
96110``` bash
97111bash <( curl -S https://raw.githubusercontent.com/DealerDirect/php-qa-tools/master/bin/install.sh)
98112```
99113
100- If you already have a global Composer setup, you can execute this to include the tools.
114+ That's it. This can be put in any instructions, such as a README or someone's blog, since the logic is in the shell
115+ script. Provided you download the script using https, the file has standard levels of authentication and encryption
116+ protecting it from manipulation.
117+
118+ This is obviously a shell script, if you're really concerned about the argument that it may contain nefarious
119+ activities within, you can easily review it before you run it.
120+
121+ ``` bash
122+ curl -o https://raw.githubusercontent.com/DealerDirect/php-qa-tools/master/bin/install.sh
123+ less install.sh
124+ bash instal.sh
125+ ```
126+
127+ If you already have a global Composer setup, you could include the tools manually, without the need for running
128+ the shell script above.
101129
102130``` bash
103- composer global require " dealerdirect/qa-tools"
131+ composer global require " dealerdirect/qa-tools:* "
104132```
105133
106- #### Project install
134+ #### Per project installation
107135
108136The other option is to install this on a per project basis.
109137
138+ Using Composer (preferred method):
139+
110140``` bash
111- composer require --dev " dealerdirect/qa-tools"
141+ composer require --dev " dealerdirect/qa-tools:* "
112142```
113143
114- Or modify your ` composer.json ` to include ` dealerdirect/qa-tools ` in the ` require-dev ` sections.
144+ Or modify your ` composer.json ` to include ` dealerdirect/qa-tools ` in the ` require-dev ` sections:
115145
116146``` json
117147{
118148 "name" : " acme/my-project" ,
119149 "require" : {
120- "** your requirements ** " : " *"
150+ "… " : " *"
121151 },
122152 "require-dev" : {
123153 "dealerdirect/qa-tools" : " *"
0 commit comments