https://github.com/dreamsicle-io/speckle
A JavaScript plugin that adds responsive, stylized speckles to any element; with no dependencies.
https://github.com/dreamsicle-io/speckle
art-generator commonjs effects javascript node-module
Last synced: 4 months ago
JSON representation
A JavaScript plugin that adds responsive, stylized speckles to any element; with no dependencies.
- Host: GitHub
- URL: https://github.com/dreamsicle-io/speckle
- Owner: dreamsicle-io
- License: gpl-3.0
- Created: 2018-02-27T05:09:53.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2018-04-27T03:05:49.000Z (about 8 years ago)
- Last Synced: 2025-09-22T05:25:51.018Z (9 months ago)
- Topics: art-generator, commonjs, effects, javascript, node-module
- Language: JavaScript
- Homepage: https://speckle.dreamsicle.io
- Size: 595 KB
- Stars: 22
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Speckle
A JavaScript module that adds responsive, stylized speckles to any element; with no dependencies.
## Getting Started
### Installation
```shell
npm install speckle-js
```
### Usage
Import the module.
```js
// Import the module using ES6.
import Speckle from 'speckle-js';
// Import the module using CommonJS.
const Speckle = require('speckle-js');
```
Use the constructor by passing a valid HTML element as the first argument, and an options object of `key: value` pairs as the second argument.
```js
new Speckle(element, options);
```
## Documentation
Visit the [documentation and examples](http://speckle.dreamsicle.io) for all options, methods, and how to use them.