write-readmelisted
Install: claude install-skill whoamimi/plugin-mimi
Prior to performing task, check that the github repository is attached to this chat, otherwise, prompt the user to attach repository.
Update the attached github repository's README.md file. Your README.md file must align with the following template example below.
# README.md Template
````markdown
# Project Title
[ensure to include shields.io badges alike examples below]
[](LICENSE)
[](https://python.org)
A concise, **one-to-two sentence description** of what this project does, the problem it solves relative to what my project's main objective and methodology.
## Highlights
- **Objective**: [main objective of the entire project]
- **Key Feature** [input the feature/method/intent/agenda of this project. If multiple features then please list in summary points]
- **Tech stack** [input how the key feature/s was/were implemented in this project e.g. depended open source library, dataset used if any,.etc]
* **Evaluation** [input how the idea/feature/model/algorithm was tested, any GPU acceleration, parallelization, or speed benchmarks]
* **Results & Conclusion** [list maximum of 2-3 summary points of the conclusion and decision made based on the idea implementation. Also, list extension to this project in moving forward]
## Project Directory Overview
[use CLI `tree` e.g. `tree -L 4 -d -I '__pycache__|.venv|node_modules' >` to return the subdirectory structure in the following example format]
Example project