Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
happy358 authored Apr 10, 2024
1 parent 2904145 commit aa24e80
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Creating torn edge and grunge paper effect using SVG and JavaScript.
## Usage
### html:
```html
<script src="https://cdn.jsdelivr.net/gh/happy358/TornPaper@v0.0.2/tornpaper.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/happy358/TornPaper@v0.0.3/tornpaper.min.js"></script>
<script>
new Tornpaper();
</script>
Expand All @@ -36,7 +36,7 @@ Creating torn edge and grunge paper effect using SVG and JavaScript.
```css
.your-class {
filter: url(#filter_tornpaper);
background-color: peachpuff;
background-color: pink;
}
```

Expand All @@ -54,10 +54,11 @@ Creating torn edge and grunge paper effect using SVG and JavaScript.
## Options
```js
new Tornpaper({
seed:1, // default:random number
tornFrequency : 0.05,
filterName : "filter_tornpaper", // cunstom filter-id, default:"filter_tornpaper"
seed : 1, // random seed, default:random number
tornFrequency : 0.05, // 0=no torn edge, default:0.05
tornScale : 10,
grungeFrequency : 0.03,
grungeFrequency : 0.03, // 0=no grunge texture, default:0.03
grungeScale : 3
});
```
Expand Down

0 comments on commit aa24e80

Please sign in to comment.