Project Guardian CLI

Table of Contents

Table of Contents

1. About The Project
   • Key Features
   • Roadmap
2. Usage
3. Contributing
4. Acknowledgments

About The Project

Project Guardian CLI automates the creation of essential markdown files and GitHub workflows for open-source projects. It addresses the repetitive task of manually setting up README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE, and GitHub workflows. The CLI aims to be agnostic, adding common files found in most open-source projects, and populating them with information from your package.json file.

Key Features

• ✅ Adds CODE_OF_CONDUCT.md, LICENSE, README.md, CONTRIBUTING.md, GitHub workflows, and issue templates with a single command.

Roadmap

• ⏳ Choose package manager for managing dependencies and github workflows.
• ⏳ Interactive CLI.
• ⏳ Add script tags depending on the project dependencies.
• ⏳ Add badges to the README.md file.

Usage

npx

npx project-guardian-cli@latest

Contributing

Contributions are welcome! If you have ideas for new features, encounter bugs, or have suggestions, please open an issue or submit a pull request on the GitHub repository.

Developers should read the Code of Conduct and the Contributing Guide.