## οΈTable of Contents
Open Contents
- [Document My Project](#document-my-project)
- [βΉοΈ About the Project](#-about-the-project)
- [π Showcase](#-showcase)
- [βοΈ Features](#-features)
- [π Stack Tech](#-stack-tech)
- [β οΈSetup](#-setup)
- [Installation](#installation)
- [Usage](#usage)
- [π Acknowledgements](#-acknowledgements)
- [ππ» Contributing](#-contributing)
- [Ways to Contribute](#ways-to-contribute)
- [Contribution Instructions](#contribution-instructions)
- [Contributors](#contributors)
- [π¨π»β About the Author](#-about-the-author)
- [π License](#-license)
## βΉοΈ About the Project
Tired of manually writing README files? this tool simplifies the process of creating documentation for Github projects.
With just a few clicks, you can generate comprehensive documentation that enhances the visibility and usability of your
repositories in seconds.
## π Showcase
## βοΈ Features
1. **Template ready**
Provide a clear and concise description of your project, highlight the main features, goals, and benefits of your
project
2. **Ease fo use**
Easily generate a well-structured README file for your GitHub project
3. **Preview**
Preview the generated README (light/dark theme) file before committing it to your repository
## π Stack Tech
- [![Angular][Angular-badge]][Angular-url] - A front-end web application framework
[Angular-badge]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular
[Angular-url]: }
- [![NgRx][NgRx-badge]][NgRx-url] - Angular state management based on Redux
[NgRx-badge]: https://img.shields.io/badge/NgRx-B7116E?style=for-the-badge&logo=ngrx
[NgRx-url]: }
- [![Tailwind CSS][Tailwind CSS-badge]][Tailwind CSS-url] - Utility-first CSS framework
[Tailwind CSS-badge]: https://img.shields.io/badge/Tailwind%20CSS-38B2AC?style=for-the-badge&logo=tailwindcss
[Tailwind CSS-url]: }
- [![TypeScript][TypeScript-badge]][TypeScript-url] - A strict syntactical superset of JavaScript
[TypeScript-badge]: https://img.shields.io/badge/TypeScript-3178C6?style=for-the-badge&logo=typescript
[TypeScript-url]: }
## β οΈSetup
### Installation
To install this project, follow these steps:
1. Install Node.js v16 or later
2. Install the required dependencies:
3. `npm install`
### Usage
After installation, you can use the project by following these steps:
1. Open the project directory in your code editor
2. Run `npm run start` to start the development server
## π Acknowledgements
- [ngx-markdown](https://www.npmjs.com/package/ngx-markdown) - Angular markdown component/directive/pipe/service to
parse static, dynamic or remote content to HTML with syntax highlight and more
- [Flowbite](https://flowbite.com/) - Build websites even faster with components on top of Tailwind CSS
- [PrismJs](https://prismjs.com/) - Prism is a lightweight, extensible syntax highlighter, built with modern web
standards in mind. Itβs used in millions of websites, including some of those you visit daily.
## ππ» Contributing
We welcome contributions from the community! If you would like to contribute to this project, please follow the
guidelines below.
### Ways to Contribute
- Report bugs or issues by opening a new issue on our GitHub repository.
- Suggest new features or improvements by opening a new issue on our GitHub repository.
- Contribute code by forking the repository, making changes, and submitting a pull request.
### Contribution Instructions
1. Fork the repository.
2. Create a new branch for your feature or bug fix: `git checkout -b my-feature-branch`.
3. Make the necessary changes and commit them: `git commit -am 'Add my new feature'`.
4. Push your branch to your forked repository: `git push origin my-feature-branch`.
5. Open a pull request against the main repository, describing the changes you made and why they should be merged.
### Contributors
- Luis Ventura (@luisvent)
## π¨π»β About the Author
**Luis Ventura**
This project was created by Luis Ventura. Connect with me on [GitHub](https://github.com/luisvent)
and [LinkedIn](https://www.linkedin.com/in/luisvent/) to learn more about my projects and professional background.
## π License
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
# Document My Project
Easily create markdown documentation for your project
