{"id":50805096,"url":"https://github.com/danielvm-git/big-kickass-readme","last_synced_at":"2026-06-13T00:05:12.663Z","repository":{"id":364312746,"uuid":"1267374542","full_name":"danielvm-git/big-kickass-readme","owner":"danielvm-git","description":"Stack-specific README writing guides based on the Kickass README template","archived":false,"fork":false,"pushed_at":"2026-06-12T13:38:37.000Z","size":30,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-12T15:20:55.029Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danielvm-git.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-06-12T13:35:35.000Z","updated_at":"2026-06-12T13:38:44.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/danielvm-git/big-kickass-readme","commit_stats":null,"previous_names":["danielvm-git/big-kickass-readme"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/danielvm-git/big-kickass-readme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielvm-git%2Fbig-kickass-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielvm-git%2Fbig-kickass-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielvm-git%2Fbig-kickass-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielvm-git%2Fbig-kickass-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielvm-git","download_url":"https://codeload.github.com/danielvm-git/big-kickass-readme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielvm-git%2Fbig-kickass-readme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34266942,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-12T02:00:06.859Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-13T00:05:11.869Z","updated_at":"2026-06-13T00:05:12.655Z","avatar_url":"https://github.com/danielvm-git.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# big-kickass-readme\n\nStack-specific README writing guides based on the [Kickass README template](https://gist.github.com/akashnimare/7b065c12d9750578de8e705fb4771d2f) by Akash.\n\nA personal reference — one file per stack, each a tailored 15-section README template with real examples from that ecosystem.\n\n## Available guides\n\n| Stack | File | What's covered |\n|-------|------|----------------|\n| Swift | [`swift-README.md`](swift-README.md) | SPM, CocoaPods, Xcode, XCTest, SwiftUI/UIKit |\n| TypeScript | [`typescript-README.md`](typescript-README.md) | npm/pnpm, tsc, Node.js, vitest |\n| Vue | [`vue-README.md`](vue-README.md) | Vue 3, Vite, SFC, Pinia, Vue Router |\n| SvelteKit | [`sveltekit-README.md`](sveltekit-README.md) | SvelteKit 5, adapters, endpoints, form actions |\n| Astro | [`astro-README.md`](astro-README.md) | Astro 5, content collections, adapters, islands |\n| Go | [`go-README.md`](go-README.md) | go mod, project layout, golangci-lint, go test |\n| Python | [`python-README.md`](python-README.md) | pip, venv, pyproject.toml, pytest |\n| Shell | [`shell-README.md`](shell-README.md) | Bash, getopts, shellcheck, bats |\n| Template | [`template-README.md`](template-README.md) | Generic 15-section base template |\n\n## The 15 sections\n\nEvery guide follows the same structure:\n\n1. Project title\n2. Motivation\n3. Build status\n4. Code style\n5. Screenshots\n6. Tech/framework used\n7. Features\n8. Code Example\n9. Installation\n10. API Reference\n11. Tests\n12. How to use\n13. Contribute\n14. Credits\n15. License\n\n## How to use\n\n1. Pick the stack that matches your project\n2. Copy the file into your new project as `README.md`\n3. Replace the placeholder content with your project's details\n\n```bash\ncp swift-README.md /path/to/new-project/README.md\n# then edit README.md with your project info\n```\n\n## Origin\n\nBased on Akash's original article — [A Beginner's Guide to Writing a Kickass README](https://meakaakka.medium.com/a-beginners-guide-to-writing-a-kickass-readme-7ac01da88ab3) and the accompanying [gist template](https://gist.github.com/akashnimare/7b065c12d9750578de8e705fb4771d2f).\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielvm-git%2Fbig-kickass-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielvm-git%2Fbig-kickass-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielvm-git%2Fbig-kickass-readme/lists"}