Skip to content

Latest commit

 

History

History
99 lines (73 loc) · 5.06 KB

README.md

File metadata and controls

99 lines (73 loc) · 5.06 KB

Motus Logo

Build Coveralls github npm bundle size Gitter GitHub issues version license maintenance

Why Motus ?

Motus allows developers to create beatuful animations that simulate CSS keyframes and are applied when the user scrolls.

Features

  • Node & Browser Support
  • Simple and intuitive api
  • Scroll hooks
  • Both vertical and horizontal scrolling

Getting started

Check out the Quick Start documentation to get started.

Live demo

Parallax demo

Usage

let newAnimation = new Motus.Animation({
  $el: document.getElementById('element'),
  keyframes: [
    {width: 100},
    {width: 300}
  ]
});
Motus.addAnimation(newAnimation);

Contributing

  • Fork it
  • Create your feature branch
  • Do something awesome
  • Commit what you have done git commit -am 'Some changes'
  • Push to the branch git push origin my-new-feature
  • Submit a pull request

For further information about the project please see the development section from the documentation.

Credits

Motus is created and maintained by Alexandru Cambose (alexcambose)

I'm open to suggestions. Feel free to message me or open an issue. Pull requests are also welcome!

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

Motus is made available under the MIT License.