Skip to content

Commit 19af93c

Browse files
committed
Fix syntax highlight and improve structure
1 parent 68d3324 commit 19af93c

File tree

1 file changed

+29
-30
lines changed

1 file changed

+29
-30
lines changed

README.md

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,47 +8,46 @@ This project won't seek to provide a perfect solution to every possible pattern,
88

99
## Usage
1010

11-
1. Include jQuery.
11+
1. Include jQuery:
1212

13-
```html
14-
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
15-
```
13+
```html
14+
<script src="http://ajax.googleapis.com/ajax/libs/jquery/2.0.0/jquery.min.js"></script>
15+
```
1616

17-
2. Include plugin's JS.
17+
2. Include plugin's code:
1818

19-
```html
20-
<script src="dist/jquery.boilerplate.min.js"></script>
21-
```
19+
```html
20+
<script src="dist/jquery.boilerplate.min.js"></script>
21+
```
2222

23-
3. Call the plugin
23+
3. Call the plugin:
2424

25-
```javascript
26-
$("#element").defaultPluginName({
27-
propertyName: "a custom value"
28-
});
29-
```
25+
```javascript
26+
$("#element").defaultPluginName({
27+
propertyName: "a custom value"
28+
});
29+
```
3030

3131
## Structure
3232

3333
The basic structure of the project is given in the following way:
3434

3535
```
36-
.
37-
|-- demo/
38-
| |-- index.html
39-
|-- dist/
40-
| |-- jquery.boilerplate.js
41-
| |-- jquery.boilerplate.min.js
42-
|-- src/
43-
| |-- jquery.boilerplate.coffee
44-
| |-- jquery.boilerplate.js
45-
|-- .editorconfig
46-
|-- .gitignore
47-
|-- .jshintrc
48-
|-- .travis.yml
49-
|-- boilerplate.jquery.json
50-
|-- Gruntfile.js
51-
`-- package.json
36+
├── demo/
37+
│ └── index.html
38+
├── dist/
39+
│ ├── jquery.boilerplate.js
40+
│ └── jquery.boilerplate.min.js
41+
├── src/
42+
│ ├── jquery.boilerplate.coffee
43+
│ └── jquery.boilerplate.js
44+
├── .editorconfig
45+
├── .gitignore
46+
├── .jshintrc
47+
├── .travis.yml
48+
├── boilerplate.jquery.json
49+
├── Gruntfile.js
50+
└── package.json
5251
```
5352

5453
#### [demo/](https://github.com/jquery-boilerplate/boilerplate/tree/master/demo)

0 commit comments

Comments
 (0)