Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marlonmarcello authored Feb 8, 2024
1 parent d106663 commit 5b036e3
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,9 @@ Customize it as you want:

## Options

Properties can be provided to the controller through the `data-config` attribute. This attribute must be **JSON** formatted and properies can be as follows:
Properties can be provided to the controller through the `data-config` attribute on the HTML element, this attribute must be **JSON** formatted, alternatively you can pass an object to the class instance as a second parameter.

Properies can be as follows:

**action** | String || Boolean | default: `'hover'`
The action that triggers the barfy stars.
Expand Down

0 comments on commit 5b036e3

Please sign in to comment.