Skip to content

Commit f3c5b3e

Browse files
committed
update readme
1 parent 7cfa260 commit f3c5b3e

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

+28-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,31 @@
11
LifterLMS Coding Standards
22
==========================
33

4-
LifterLMS Coding Standards (LifterLMS-CS) is a project with rulesets for code style and quality intended for use in LifterLMS projects.
4+
LifterLMS Coding Standards (LifterLMS-CS) is a project with rulesets for code style and quality intended for use in LifterLMS projects.
5+
6+
7+
## Installation
8+
9+
To include in a project require as a development dependency:
10+
11+
`composer require lifterlms/lifterlms-cs:dev-master --dev`
12+
13+
Note that Composer won't run configuration scripts in this scenario and the root project needs to take care of it.
14+
15+
## Developing LifterLMS-CS
16+
17+
To include in a project and make changes to the LifterLMS-CS project itself:
18+
19+
Add to your `composer.json` file with the `@dev` tag and reference your local copy of this repository in the repositories block:
20+
21+
```json
22+
"require-dev": {
23+
"lifterlms/lifterlms-cs": "@dev"
24+
},
25+
"repositories": [
26+
{
27+
"type": "path",
28+
"url": "/absolute/path/to/lifterlms-cs"
29+
}
30+
]
31+
```

0 commit comments

Comments
 (0)