AoS.js

How to install

Execute: npm install https://github.com/DryByte/AoS.js

How to use

Check examples folder in the repository, in there you can check some examples. Remember to change require("../src") to require("aos.js").

Getting the docs on web

Online docs:

You can acess the docs on: https://drybyte.github.io/docs

Generating on local:

The docs are generated using jsdoc and better-docs to generate a simple website. Follow the steps to use the docs on web:

• Clone the repository: git clone https://github.com/DryByte/AoS.js.git
• Then run: npm i && npm run generate-docs

Now just open the file docs/index.html on your browser.

Contributing

You can contribute reporting bugs, issues, giving ideas, doing pull requests, or also giving a feedback.