File tree Expand file tree Collapse file tree 1 file changed +42
-0
lines changed Expand file tree Collapse file tree 1 file changed +42
-0
lines changed Original file line number Diff line number Diff line change @@ -87,6 +87,48 @@ The following packages are suggested:
87
87
[ phpDox ] : http://phpdox.de
88
88
[ Sami ] : https://github.com/FriendsOfPHP/sami
89
89
90
+ ## Usage
91
+
92
+ This is a simple metapackage, but still can be used in different ways.
93
+
94
+ #### Global install
95
+
96
+ This is by far the easiest and most convenient method. Simply having all the tools available system wide.
97
+
98
+ The following script will install a system wide Composer for you, including the QA tools.
99
+
100
+ ``` bash
101
+ bash <( curl -S https://raw.github.com/DealerDirect/php-qa-tools/master/bin/install.sh)
102
+ ```
103
+
104
+ If you already have a global Composer setup, you can execute this to include the tools.
105
+
106
+ ``` bash
107
+ composer global require " dealerdirect/qa-tools"
108
+ ```
109
+
110
+ #### Project install
111
+
112
+ The other option is to install this on a per project basis.
113
+
114
+ ``` bash
115
+ composer require --dev " dealerdirect/qa-tools"
116
+ ```
117
+
118
+ Or modify your ` composer.json ` to include ` dealerdirect/qa-tools ` in the ` require-dev ` sections.
119
+
120
+ ``` json
121
+ {
122
+ "name" : " acme/my-project" ,
123
+ "require" : {
124
+ "** your requirements **" : " *"
125
+ },
126
+ "require-dev" : {
127
+ "dealerdirect/qa-tools" : " *"
128
+ }
129
+ }
130
+ ```
131
+
90
132
## Contributing
91
133
92
134
This is an active open-source project. We are always open to people who want to use the code or contribute to it.
You can’t perform that action at this time.
0 commit comments