Skip to content

Commit e368706

Browse files
author
Shalom Sam
committed
minor updates to example packages, updates to both readme files, minor cosmetic changes
1 parent d058c35 commit e368706

File tree

6 files changed

+393
-13695
lines changed

6 files changed

+393
-13695
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# react-canvas-js
1+
# react-canvas-js ([demo](https://shalomsam.github.io/react-canvas-js/))
22

3-
> Awesome HTML Canvas Particle animation in React!
3+
> :rocket: Awesome HTML Canvas animations in React!
44
55
[![NPM](https://img.shields.io/npm/v/react-canvas-js.svg)](https://www.npmjs.com/package/react-canvas-js) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
66

@@ -10,6 +10,7 @@
1010
npm install --save react-canvas-js
1111
```
1212

13+
1314
## Usage
1415

1516
```jsx
@@ -38,6 +39,7 @@ class Example extends Component {
3839
}
3940
```
4041

42+
4143
## Available Options
4244

4345
Option | Type | Required | Default | Description
@@ -66,6 +68,7 @@ debugOptions.enabled | `boolean` | Yes | `false` | Enables debugging, and binds
6668
debugOptions.attachAllParticles | `boolean` | No | `false` | Binds all the Particle objects to `window.Particles`.
6769
debugOptions.showFrameRate | `boolean` | No | Shows a frame rate blurb over the canvas, indicating the frame rate achieved by that canvas.
6870

71+
6972
## Planned Features (checklist)
7073

7174
- [ ] Add interaction support.
@@ -78,6 +81,7 @@ debugOptions.showFrameRate | `boolean` | No | Shows a frame rate blurb over the
7881

7982
*My goal is to progress to more than just Particle animation, by simplifying and adding support for all canvas animation use cases. Suggestions and feedback are welcome too.*
8083

84+
8185
## Contributing
8286

8387
I could use some assistance in building and improving this component. I'll welcome pull requests for bug fixes, new features, improvements and writing test cases. If you are interested head on over to the [Issues](https://github.com/shalomsam/react-canvas-js/issues) section, and pick up any of the issue(s) that interest you. The issues with label `need help` could really do with some help (as the label suggests). Please create your pull requests to the `develop` branch. Top Contributors will be added here under the contributors section (if you'd like that).
@@ -90,6 +94,7 @@ I could use some assistance in building and improving this component. I'll welco
9094
+ You can checkout this <a href="http://react.shalomsam.com" title="Full Stack Developer, Angular Portfolio" target="_blank">React Portfolio here</a>
9195
+ A scope of my work @ <a title="Web Software Developer Portfolio" target="_blank" href="https://react.shalomsam.com/portfolio">React Portfolio</a>
9296

97+
9398
## License
9499

95100
MIT © [shalomsam](https://github.com/shalomsam)

0 commit comments

Comments
 (0)