diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..0f2c956 --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,4 @@ +{ + "projectName": "kdm-cli", + "projectOwner": "KDM-cli" +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 235050d..920a950 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,6 +55,25 @@ To set up your development environment: npm run test ``` +## Contributors + +This project follows the [All Contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome! + +### Adding Yourself as a Contributor + +We use the [All Contributors Bot](https://allcontributors.org/docs/en/bot/overview) to automate adding contributors. You can add yourself by leaving a comment on your Pull Request or any Issue: + +``` +@all-contributors please add @ for +``` + +For example, to add yourself for code contribution: +``` +@all-contributors please add @your-username for code +``` + +For a list of valid contribution types, see the [Emoji Key](https://allcontributors.org/docs/en/emoji-key). + ## Coding Style Please ensure your code is idiomatic and follows the existing TypeScript conventions in the codebase. diff --git a/README.md b/README.md index 2f3a4b7..3ce051c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # KDM — Kubernetes + Docker Monitoring CLI +[![All Contributors](https://img.shields.io/github/all-contributors/KDM-cli/kdm-cli?color=ee8449&style=flat-square)](#contributors) + KDM (Kubernetes Docker Monitor) is a lightweight, terminal-based monitoring CLI tool that automatically detects and monitors running Docker containers and Kubernetes pods. It provides real-time resource usage, health status, and unified views of your runners. ## Features @@ -65,6 +67,17 @@ KDM is built with: - **Ink** for terminal UI - **tsup** for high-performance bundling +## Contributors + + + + + + + + + + ## License MIT