Skip to content

Commit efbb55f

Browse files
committed
Fix documentation and add minified version
1 parent a78d526 commit efbb55f

2 files changed

Lines changed: 6 additions & 17 deletions

File tree

README.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ A small jQuery plugin that will automatically cast a shadow creating depth for y
33
Created by [Pete R.](http://www.thepetedesign.com), Founder of [BucketListly](http://www.bucketlistly.com)
44

55
## Usage
6-
To use `jquery.flatshadow.js` on your website, simply include the latest jQuery library found here together with `jquery.flatshadow.js` into your document's `<head>` and call the function like this:
6+
To use this on your website, simply include the latest jQuery library found here together with `jquery.flatshadow.js` into your document's `<head>`, follow by the html markup and a function call as follows:
77

88
````html
99
<div class="flat-icon"> FLAT </div>
@@ -13,25 +13,13 @@ To use `jquery.flatshadow.js` on your website, simply include the latest jQuery
1313

1414
````javascript
1515
$(".flat-icon").flatshadow({
16-
color: "#2ecc71",
17-
angle: "SE",
18-
fade: true,
19-
boxShadow: "#d7cfb9"
16+
color: "#2ecc71", // Background color of elements inside. (Color will be random if left unassigned)
17+
angle: "SE", // Shadows direction. Available options: N, NE, E, SE, S, SW, W and NW. (Angle will be random if left unassigned)
18+
fade: true, // Gradient shadow effect
19+
boxShadow: "#d7cfb9" // Color of the Container's shadow
2020
});
2121
````
2222

23-
### Color
24-
The color option allows you to assign a background color to all your elements at once. Color will be random if empty.
25-
26-
### Angle
27-
The angle option allows you to assign the direction (N, NE, E, SE, S, SW, W and NW ) of the shadow of the elements inside. Angle will be random if empty.
28-
29-
### Fade
30-
The fade option will turn the flat shadow effect into a gradient shadow effect.
31-
32-
### boxShadow
33-
The boxShadow allows you to apply the same shadow effect to the container of the elements. The option accept a 6 hex color code. For example, "#000000".
34-
3523
## Further Customization
3624
With `jquery.flatshadow.js`, you can apply each individual elements with different effect by simply add a `data-color` and `data-angle` to your mark up as follows:
3725

jquery.flatshadow.min.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)