Rewrite README and add documentation - Githubissues

locomotivemtl / locomotive-boilerplate

🚂 Front-end boilerplate for projects by Locomotive.

https://locomotivemtl-boilerplate.vercel.app/

MIT License

458 stars 71 forks source link

Rewrite README and add documentation #107

Closed mcaskill closed 2 years ago

mcaskill commented 2 years ago

And split sections from README into dedicated documentation files.

Added:

"Features" section to summarize the boilerplate's architecture.
"Getting Started" section to describe how to create a project from the boilerplate.
Development documentation to describe how NPM dependencies, configuring assets and tasks.
Technologies documentation to describe CSS, JS, Locomotive Scroll, ModularLoad, ModularJS.

Changed:

Moved section "Configuration" to docs/development.md.
Moved sections "Styles", "Scripts", "Page transitions", and "Scroll detection" to docs/technologies.md.