ReadMe Ranker is a command-line tool that analyzes the README files of your projects and provides a comprehensive report based on various criteria. It helps you improve the quality of your README files, ensuring they are informative and well-structured.
- Analyze README files for clarity, completeness, and formatting.
- Generate a detailed report highlighting areas for improvement.
- Easy to use via command line with
npx.
You can easily install ReadMe Ranker using npm. Run the following command in your terminal:
npx readme-ranker
To analyze a README file, simply run:
npx readme-ranker <path-to-your-readme>
Replace <path-to-your-readme> with the path to the README file you want to analyze.
npx readme-ranker ./README.mdContributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for more details.