{"id":31230806,"url":"https://github.com/tonycletus/ghread","last_synced_at":"2026-04-28T12:02:59.735Z","repository":{"id":314674213,"uuid":"1056357661","full_name":"tonycletus/ghread","owner":"tonycletus","description":"Generate beautiful GitHub README profiles instantly with a simple command. TypeScript CLI tool with interactive setup, multiple themes, and auto-updating stats.","archived":false,"fork":false,"pushed_at":"2025-09-14T10:49:16.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-11T05:11:36.738Z","etag":null,"topics":["cli","github","npm-package","profile","readme","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/ghread","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tonycletus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":null,"dco":null,"cla":null}},"created_at":"2025-09-13T23:14:20.000Z","updated_at":"2025-09-14T10:49:20.000Z","dependencies_parsed_at":"2025-09-14T02:32:43.350Z","dependency_job_id":"239b78c6-7f48-4d37-82e5-753a8af0d26d","html_url":"https://github.com/tonycletus/ghread","commit_stats":null,"previous_names":["tonycletus/ghread"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tonycletus/ghread","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonycletus%2Fghread","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonycletus%2Fghread/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonycletus%2Fghread/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonycletus%2Fghread/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tonycletus","download_url":"https://codeload.github.com/tonycletus/ghread/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tonycletus%2Fghread/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32379629,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T11:25:28.583Z","status":"ssl_error","status_checked_at":"2026-04-28T11:25:05.435Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["cli","github","npm-package","profile","readme","typescript"],"created_at":"2025-09-22T10:10:50.774Z","updated_at":"2026-04-28T12:02:59.730Z","avatar_url":"https://github.com/tonycletus.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ghread\n\nGenerate beautiful GitHub README profiles instantly with a simple command.\n\n[![npm version](https://badge.fury.io/js/ghread.svg)](https://badge.fury.io/js/ghread)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?logo=typescript\u0026logoColor=white)](https://www.typescriptlang.org/)\n[![tsup](https://img.shields.io/badge/bundled%20with-tsup-FF6B6B?logo=esbuild\u0026logoColor=white)](https://tsup.egoist.dev/)\n\n## Quick Start\n\n```bash\n# Generate your README instantly (no installation needed!)\nnpx ghread init\n```\n\n**Alternative:** Install globally for repeated use\n```bash\nnpm install -g ghread\nghread init\n```\n\n## Examples\n\n### Interactive Setup\n```bash\n$ npx ghread init\n\nWelcome to ghread! Let's create your GitHub profile\n\n? What's your name? Tony Cletus\n? What's your GitHub username? tonycletus\n? What's your professional title? Full Stack Developer\n? Write a short bio about yourself: Passionate developer building amazing things\n? Your Twitter handle (without @): iamtonycletus\n? Your LinkedIn username: tonycletus\n? Your email: hello@tonycletus.com\n? Your website URL: https://tonycletus.com\n? Choose a theme: Tokyo Night\n\nREADME.md generated successfully!\n\nNext steps:\n1. Review your README.md file\n2. Commit and push to your GitHub profile repository\n3. Your profile will be live at github.com/tonycletus\n```\n\n### Generated README Preview\n```markdown\n# Hi there\n\n**Welcome to my corner of the digital world!**\n\nI'm **Tony Cletus**, and this profile is a glimpse into my journey as a Full Stack Developer.\n\n---\n\n### About Me\n- **Passion**: Passionate developer building amazing things\n- **Growth**: Lifelong learner, exploring tech and coding every day  \n- **Collaboration**: Open to open-source and research collaborations  \n- **Focus**: Tech, AI, coding, and privacy-aware systems  \n- **Beyond Code**: Traveler, family-oriented, and driven by curiosity  \n- **Fun fact**: I drink Garri, not Coffee  \n\nConnect with me:  \n[![Twitter Badge](https://img.shields.io/badge/-@iamtonycletus-1DA1F2?style=flat\u0026logo=twitter\u0026logoColor=white)](https://twitter.com/iamtonycletus)  \n[![LinkedIn Badge](https://img.shields.io/badge/-Tony%20Cletus-0077B5?style=flat\u0026logo=linkedin\u0026logoColor=white)](https://www.linkedin.com/in/tonycletus)  \n[![Email Badge](https://img.shields.io/badge/-hello@tonycletus.com-EA4335?style=flat\u0026logo=gmail\u0026logoColor=white)](mailto:hello@tonycletus.com)\n[![Website Badge](https://img.shields.io/badge/-Website-000000?style=flat\u0026logo=About.me\u0026logoColor=white)](https://tonycletus.com)\n\n---\n\n### GitHub Stats (auto-updating)\n![Tony Cletus's GitHub stats](https://github-readme-stats.vercel.app/api?username=tonycletus\u0026show_icons=true\u0026count_private=true\u0026theme=tokyonight)\n\n![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=tonycletus\u0026layout=compact\u0026count_private=true\u0026theme=tokyonight)\n\n![GitHub Streak](https://streak-stats.demolab.com?user=tonycletus\u0026theme=tokyonight\u0026hide_border=false)\n\n---\n\n### Contribution Graph\n![Contribution Graph](https://github-readme-activity-graph.vercel.app/graph?username=tonycletus\u0026theme=tokyonight\u0026hide_border=false)\n\n---\n\n*\"Let's change the world one code at a time.\"*\n```\n\n## Usage\n\n### Interactive Setup\n```bash\nnpx ghread init\n```\nThis will guide you through creating your profile with prompts for:\n- Name and GitHub username\n- Professional title and bio\n- Social media links (Twitter, LinkedIn, etc.)\n- Theme selection\n\n### From Config File\n```bash\nnpx ghread generate\n```\nUses your `ghread.config.json` file to generate the README.\n\n### Programmatic Usage\n```typescript\nimport { generateReadme, GhreadConfig } from 'ghread';\n\nconst config: GhreadConfig = {\n  name: 'Tony Cletus',\n  username: 'tonycletus',\n  title: 'Full Stack Developer',\n  bio: 'Passionate developer building amazing things',\n  twitter: 'iamtonycletus',\n  linkedin: 'tonycletus',\n  email: 'hello@tonycletus.com',\n  website: 'https://tonycletus.com',\n  theme: 'tokyonight'\n};\n\n// Generate README\nawait generateReadme(config);\n```\n\n## Features\n\n- **Comprehensive Templates**: Professional GitHub profile layouts with advanced sections\n- **Multiple Themes**: Choose from 6+ color themes (tokyonight, dark, radical, etc.)\n- **Modular Sections**: Choose which sections to include (11 different sections available)\n- **Advanced Analytics**: GitHub stats, contribution graphs, achievement gallery\n- **Tech Stack Showcase**: Professional tech badges and tools display\n- **Blog Integration**: Latest articles and blog posts section\n- **Featured Projects**: Highlight your best projects with GitHub stats\n- **Fun Elements**: Developer quotes and jokes for personality\n- **Real-time Stats**: Profile views, followers, and stars tracking\n- **Auto-updating Content**: All stats update automatically\n- **Fast Build**: Powered by [tsup](https://www.npmjs.com/package/tsup) and esbuild\n- **TypeScript**: Full type safety and modern development experience\n\n## Themes\n\n- `tokyonight` (default)\n- `dark`\n- `radical`\n- `merko`\n- `gruvbox`\n- `dracula`\n\n## Available Sections\n\nChoose from 11 different sections to customize your profile:\n\n- **About Me** - Personal introduction and bio\n- **GitHub Analytics** - Stats and top languages\n- **GitHub Streak** - Contribution streak display\n- **Contribution Heatmap** - Visual activity graph\n- **Achievement Gallery** - GitHub profile trophies\n- **Tech \u0026 Tools** - Technology stack badges\n- **Latest Articles** - Blog posts and articles\n- **Featured Projects** - Highlighted repositories\n- **Fun \u0026 Inspiration** - Developer quotes and jokes\n- **Real-Time Stats** - Profile views and followers\n- **Custom Sections** - Add your own sections\n\n## Configuration\n\nYour `ghread.config.json` looks like this:\n\n```json\n{\n  \"name\": \"Tony Cletus\",\n  \"username\": \"tonycletus\",\n  \"title\": \"Full Stack Developer\",\n  \"bio\": \"Passionate developer building innovative solutions\",\n  \"twitter\": \"iamtonycletus\",\n  \"linkedin\": \"tonycletus\",\n  \"email\": \"hello@tonycletus.com\",\n  \"website\": \"https://tonycletus.com\",\n  \"github\": \"tonycletus\",\n  \"stackoverflow\": \"123456\",\n  \"theme\": \"tokyonight\",\n  \"sections\": {\n    \"aboutMe\": true,\n    \"githubStats\": true,\n    \"topLanguages\": true,\n    \"streak\": true,\n    \"contributionGraph\": true,\n    \"achievementGallery\": false,\n    \"techTools\": false,\n    \"blogArticles\": false,\n    \"featuredProjects\": false,\n    \"funSections\": false,\n    \"realTimeStats\": false\n  }\n}\n```\n\n## Development\n\n```bash\n# Clone the repo\ngit clone https://github.com/tonycletus/ghread.git\ncd ghread\n\n# Install dependencies\nnpm install\n\n# Build with tsup (powered by esbuild)\nnpm run build\n\n# Link for local development\nnpm link\n\n# Watch mode for development\nnpm run dev\n```\n\n## License\n\nMIT © [Tony Cletus](https://github.com/tonycletus)\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonycletus%2Fghread","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftonycletus%2Fghread","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftonycletus%2Fghread/lists"}