Merge pull request #3 from UlisesGascon/docs/added-documentation

docs: added proper documentation

Author: UlisesGascon

README.md

@@ -1,2 +1,82 @@
-# generator-fast-documentation
-A yeoman-based template to generate a great documentation website
+<p align="center">
+<h1 align="center">
+  generator-fast-documentation
+</h1>
+
+<p align="center">
+  A yeoman-based template to generate a great documentation website
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.org/package/generator-fast-documentation"><img src="https://badgen.net/npm/v/generator-fast-documentation" alt="npm version"/></a>
+  <a href="https://www.npmjs.org/package/generator-fast-documentation"><img src="https://badgen.net/npm/license/generator-fast-documentation" alt="license"/></a>
+  <a href="https://www.npmjs.org/package/generator-fast-documentation"><img src="https://badgen.net/npm/dt/generator-fast-documentation" alt="downloads"/></a>
+  <a href="https://snyk.io/test/github/ulisesgascon/generator-fast-documentation"><img src="https://snyk.io/test/github/ulisesgascon/generator-fast-documentation/badge.svg" alt="Known Vulnerabilities"/></a>
+</p>
+
+</p>
+
+# About
+
+A yeoman-based template to generate a great documentation website.
+
+❤️ Awesome Features:
+
+- Ship fast! Docker support. 🔥
+- Opinionated Docusaurus config out-of-the-box 🍺
+- Easy control releases with standard-release out-of-the-box 🎉
+- Simple CI with github Actions out-of-the-box 📦
+- Just few simple questions to generate the perfect documentation 💪
+- Easy to use and great test coverage ✅
+
+
+
+## Usage
+
+You need to install [Yeoman](https://www.npmjs.com/package/yo)
+
+```bash
+npm i -g generator-fast-documentation
+yo fast-documentation
+```
+
+## Built With
+
+Development only:
+
+- [@commitlint/cli](https://www.npmjs.com/package/@commitlint/cli) - Lint commit messages
+- [@commitlint/config-conventional](https://www.npmjs.com/package/@commitlint/config-conventional) - npm i @commitlint/config-conventional
+- [jest](https://www.npmjs.com/package/jest) - Delightful JavaScript Testing
+- [standard](https://www.npmjs.com/package/standard) - JavaScript style guide, linter, and formatter
+- [standard-version](https://www.npmjs.com/package/standard-version) - A utility for versioning using semver and CHANGELOG generation powered by Conventional Commits.
+- [yeoman-assert](https://www.npmjs.com/package/yeoman-assert) - yeoman-assert is extending the native Node.js assert module.
+- [yeoman-test](https://www.npmjs.com/package/yeoman-test) - Test utilities for Yeoman generators
+- [husky](https://www.npmjs.com/package/husky) - Modern native Git hooks made easy
+
+Production only:
+
+- [chalk](https://www.npmjs.com/package/chalk) - Terminal string styling done right
+- [yeoman-generator](https://www.npmjs.com/package/yeoman-generator) - Rails-inspired generator system that provides scaffolding for your apps
+- [yosay](https://www.npmjs.com/package/yosay) - Tell Yeoman what to say
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ulisesGascon/generator-fast-documentation/tags).
+
+## Authors
+
+- **Ulises Gascón** - *Initial work- - [@ulisesGascon](https://github.com/ulisesGascon)
+
+See also the list of [contributors](https://github.com/ulisesGascon/generator-fast-documentation/contributors) who participated in this project.
+
+## License
+
+This project is licensed under the GNU AGPL3.0 License - see the [LICENSE.md](LICENSE.md) file for details
+
+## Acknowledgments
+
+- This project is under development, but you can help us to improve it! We :heart: FOSS!