corpwork-readme-generator
Corpwork's private VS Code extension. Automatically generates standardized README.md files through static analysis of your repository.
Features
- Automatic detection of 30+ technologies with shields.io badges
- Directory tree generation of the repository
- Service detection (Docker Compose, Dockerfile, NGINX)
- Dependency counting (Node, Python, Go, Java, PHP, Ruby, Rust)
- CI/CD detection (GitLab CI, GitHub Actions, Jenkins, Azure Pipelines, CircleCI, Travis CI)
- Quick start commands and prerequisites suggestions
Supported Technologies
And many more (Express, NestJS, Django, Flask, FastAPI, Spring Boot, Laravel, Rails, Vite, Webpack, Tailwind, ESLint, Prettier, Helm, Redis, PostgreSQL, MongoDB, MySQL, RabbitMQ, Kafka, Jest, SonarQube, AWS, Azure, GCP...)
How to use
Via Command Palette
- Open VS Code in your project
- Press
Ctrl+Shift+P
- Type "CorpWork: Generate README"
- The README.md will be generated at the project root
Via right-click
- In the VS Code Explorer, right-click on a folder
- Select "Generate README"
- The README.md will be generated in the selected folder
What is analyzed
| Analysis |
Source |
| Technologies |
package.json, file extensions, Dockerfile, docker-compose.yml |
| Services |
docker-compose.yml, Dockerfile, nginx.conf |
| Dependencies |
package.json, requirements.txt, go.mod, pom.xml, Cargo.toml, composer.json, Gemfile |
| CI/CD |
.gitlab-ci.yml, .github/workflows/, Jenkinsfile |
| Structure |
Directory tree (up to 4 levels deep) |
| Project name |
git remote (fallback: folder name) |
| Logo |
Searches in docs/, assets/, .github/, root |
Privacy
Analysis is 100% local. No data from your repository is sent to external services.
License
MIT — © Corpwork. All rights reserved.
| |
