diff --git a/README.md b/README.md index b142cc1..acfc4c1 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,12 @@ The "Beautiful Backgrounds" library offers a collection of customizable web comp ## Installation +Using [`npm`][npm]: + ```sh npm i beautiful-backgrounds --save ``` -In Deno with [`esm.sh`][esmsh]: - ```js import { BbStarTrail } from 'beautiful-backgrounds'; ``` @@ -26,19 +26,16 @@ In browsers with [`esm.sh`][esmsh]: ```html ``` ## Usage -```js -import { BbStarTrail } from 'beautiful-backgrounds'; -``` +### Star Trail ```html +``` + +#### Attributes for bb-digital-rain + +- `data-characters`: Sets the characters for the digital rain effect. +- `data-font-size`: Defines the font size of the falling characters. +- `data-font-color-hue-start`: Specifies the starting color hue for the rain. +- `data-font-color-hue-end`: Sets the ending color hue for the rain. +- `data-font-speed`: Controls the falling speed of the digital rain. + [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/A0A3QJPZ9) [esmsh]: https://esm.sh +[npm]: https://www.npmjs.com/package/beautiful-backgrounds [examples]: https://codepen.io/collection/aMPozo