Toolverse
All skills
DevOps

readme

by sickn33

When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for help with README.md. This skill creates absurdly thorough documentation covering

Installation

Pick a client and clone the repository into its skills directory.

Installation

Quick info

Author
sickn33
Category
DevOps
Views
23
GitHub repo

About this skill

When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architecture, and deployment.

How to use

  1. Wyzwól umiejętność, pisząc do asystenta: "napisz readme", "utwórz dokumentację projektu" lub "pomóż mi z README.md". Możesz też powiedzieć "dokumentuj ten projekt" lub "project documentation".

  2. Umiejętność przeanalizuje strukturę Twojego repozytorium — przeszuka katalogi, pliki konfiguracyjne (.env, docker-compose.yml, Dockerfile), schemat bazy danych (db/schema.rb) i pliki CI/CD (.github/workflows).

  3. Zidentyfikuje główny punkt wejścia aplikacji, framework (Rails, Node.js, Go, Python) i sposób wdrażania (Kamal, Fly.io, Render, Heroku).

  4. Wygeneruje README zawierające trzy sekcje: instrukcje uruchomienia lokalnego, szczegółowe wyjaśnienie architektury systemu oraz kroki do wdrożenia w produkcji.

  5. Przejrzyj wygenerowaną dokumentację i dostosuj ją do specyfiki Twojego projektu — dodaj lub usuń sekcje zależnie od potrzeb.

  6. Zapisz plik README.md w głównym katalogu repozytorium i zatwierdź zmiany w kontroli wersji.

Related skills

grafana-dashboards

by wshobson

Create and manage production Grafana dashboards for real-time visualization of system and application metrics. Use when building monitoring dashboards, visualizing metrics, or creating operational observability interfaces.

DevOps
92262

trello

by openclaw

Manage Trello boards, lists, and cards via the Trello REST API.

DevOps
23107

azure-devops-rest-api

by Tiberriver256

Guide for working with Azure DevOps REST APIs and OpenAPI specifications. Use this skill when implementing new Azure DevOps API integrations, exploring API capabilities, understanding request/response formats, or referencing the official OpenAPI specifications from the

DevOps
995

aws-solution-architect

by alirezarezvani

Design AWS architectures for startups using serverless patterns and IaC templates. Use when asked to design serverless architecture, create CloudFormation templates, optimize AWS costs, set up CI/CD pipelines, or migrate to AWS. Covers Lambda, API Gateway, DynamoDB, ECS, Aurora,

DevOps
1231

file-organizer

by ComposioHQ

Intelligently organizes your files and folders across your computer by understanding context, finding duplicates, suggesting better structures, and automating cleanup tasks. Reduces cognitive load and keeps your digital workspace tidy without manual effort.

DevOps
1399

pmbok-project-management

by jgtolentino

Comprehensive PMP/PMBOK project management methodologies and best practices. Use this skill when users need guidance on project management processes, templates, knowledge areas, process groups, tools, techniques, or certification preparation. Covers all 10 PMBOK Knowledge Areas

DevOps
21133