Skip to content

Commit dabe81f

Browse files
author
FezVrasta
committed
fixed readme
1 parent 855c645 commit dabe81f

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ so this might not be true before the first stable release.
2222

2323
## Getting started
2424

25-
Navigate to the `template/` folder in this repository, and you will see the `index.html` file, which has the CSS include statements, in the `head` section and the JS includes just before `body` section closes.
26-
You need to copy the `material/` folder to the root of your project, ensuring that all the files in your project can access the files through the relative URL, supplied in the CSS and the JS includes.
25+
Navigate to the `dist/` folder in this repository, and you will see the `test.html` file, which has the CSS include statements, in the `head` section and the JS includes just before `body` section closes.
26+
You need to copy the `dist/` folder to the root of your project, ensuring that all the files in your project can access the files through the relative URL, supplied in the CSS and the JS includes.
2727

2828
## Todo
2929

@@ -95,7 +95,7 @@ Variations are available for every icon, including the original Bootstrap icons.
9595
The syntax to add a Material icon is:
9696

9797
<i class="icon icon-material-favorite"></i>
98-
98+
9999
# Material.js
100100

101101
Material.js is a jQuery plugin that add some magic to your markup and allows Material Design for Bootstrap to style some elements like inputs, checkboxes, radios etc.
@@ -104,31 +104,31 @@ Material.js is a jQuery plugin that add some magic to your markup and allows Mat
104104

105105
This plugin exposes some functions, them are:
106106

107-
`$.material.inits` is a shortcut to run all the following commands.
108-
`$.material.ripples()` will apply ripples.js to the default elements.
109-
`$.material.input()` will enable the MD style to the text inputs, and other kind of inputs (number, email, file etc).
110-
`$.material.checkbox():` will enable the MD style to the checkboxes (remember to follow the markup guidelines explained in the Inputs chapter.
111-
`$.material.radio():` will enable the MD style to the checkboxes (remember to follow the markup guidelines explained in the Inputs chapter.
107+
`$.material.inits` is a shortcut to run all the following commands.
108+
`$.material.ripples()` will apply ripples.js to the default elements.
109+
`$.material.input()` will enable the MD style to the text inputs, and other kind of inputs (number, email, file etc).
110+
`$.material.checkbox():` will enable the MD style to the checkboxes (remember to follow the markup guidelines explained in the Inputs chapter.
111+
`$.material.radio():` will enable the MD style to the checkboxes (remember to follow the markup guidelines explained in the Inputs chapter.
112112

113113
### Apply Material.js only to specific elements:
114114

115115
Every function expects an optional value that will be used as selector for the function, for example
116-
`$.material.ripples("#selector, #foobar")` will apply Ripples.js only to `#selector` and `#foobar`.
117-
The functions that allows an optional selector are `$.material.ripples`, `$.material.input`, `$.material.checkbox` and `$.material.radio`.
118-
116+
`$.material.ripples("#selector, #foobar")` will apply Ripples.js only to `#selector` and `#foobar`.
117+
The functions that allows an optional selector are `$.material.ripples`, `$.material.input`, `$.material.checkbox` and `$.material.radio`.
118+
119119
You can even override the default values using the `$.material.options` function, the default values are:
120-
120+
121121
$.material.options = {
122122
"withRipples": ".btn:not(.btn-link), .card-image, .navbar a:not(.withoutripple), .nav-tabs a:not(.withoutripple), .withripple",
123123
"inputElements": "input.form-control, textarea.form-control, select.form-control",
124124
"checkboxElements": ".checkbox > label > input[type=checkbox]",
125125
"radioElements": ".radio > label > input[type=radio]"
126126
}
127-
127+
128128
### Arrive.js support
129129

130130
If you need to dynamically add elements to your DOM then you may need to include Arrive.js before Material.js, this will automatically apply Material.js to every new element added by you using JS.
131-
131+
132132

133133
# Plugins
134134

0 commit comments

Comments
 (0)