gh-tldr 1.0.8 → 1.0.10

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 yungweng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,35 @@
+<p align="center">
+  <img src="https://img.shields.io/npm/v/gh-tldr.svg" alt="npm version">
+  <img src="https://img.shields.io/npm/l/gh-tldr.svg" alt="license">
+  <img src="https://img.shields.io/node/v/gh-tldr.svg" alt="node version">
+</p>
+
 # gh-tldr
 
-Generate a TL;DR summary of your GitHub activity using Claude.
+**AI-powered TL;DR of your GitHub activity**
+
+Stop manually tracking what you did this week. `gh-tldr` fetches your GitHub activity and uses Claude AI to generate a human-readable summary—perfect for standups, status updates, or weekly reports.
+
+<p align="center">
+  <img src="assets/demo.gif" alt="gh-tldr demo" width="700">
+</p>
+
+## Quick Start
+
+```bash
+npx gh-tldr
+```
+
+That's it. Follow the prompts.
+
+## Features
+
+- 📊 Summarizes PRs, reviews, commits, and issues
+- 🤖 Powered by Claude AI for natural language summaries
+- 🔄 Interactive or scripted mode
+- 📝 Multiple output formats (plain text, markdown, slack)
+- 🔒 Private repository support
+- 🌍 English and German output
 
 ## Prerequisites
 
@@ -8,35 +37,37 @@ Generate a TL;DR summary of your GitHub activity using Claude.
 - [GitHub CLI](https://cli.github.com/) (`gh`) - authenticated
 - [Claude Code](https://docs.anthropic.com/en/docs/claude-code) (`claude`)
 
+<details>
+<summary>macOS quick setup</summary>
+
 ```bash
-# macOS
 brew install gh node
-
-# Authenticate gh
 gh auth login
 ```
 
+</details>
+
 ## Installation
 
+The easiest way is `npx gh-tldr` (no install needed).
+
+<details>
+<summary>Alternative: Install globally</summary>
+
 ```bash
-# Clone and install
 git clone https://github.com/yungweng/gh-tldr.git
 cd gh-tldr
 pnpm install
 pnpm build
-
-# Link globally
 pnpm link --global
 ```
 
-Or via npx:
-```bash
-npx gh-tldr
-```
+</details>
 
-### Note for Aikido Safe-Chain Users
+<details>
+<summary>Note for Aikido Safe-Chain users</summary>
 
-If you use [Aikido Safe-Chain](https://github.com/AikidoSec/safe-chain), you may need to bypass it when running via npx:
+If you use [Aikido Safe-Chain](https://github.com/AikidoSec/safe-chain), you may need to bypass it:
 
 ```bash
 # Bash/Zsh
@@ -46,7 +77,7 @@ If you use [Aikido Safe-Chain](https://github.com/AikidoSec/safe-chain), you may
 command npx gh-tldr
 ```
 
-Or add an alias to your shell config:
+Or add an alias:
 ```bash
 # ~/.bashrc or ~/.zshrc
 alias gh-tldr='\npx gh-tldr'
@@ -55,12 +86,12 @@ alias gh-tldr='\npx gh-tldr'
 alias gh-tldr='command npx gh-tldr'
 ```
 
+</details>
+
 ## Usage
 
 ### Interactive Mode
 
-Run without arguments for guided prompts:
-
 ```bash
 gh-tldr
 ```
@@ -76,25 +107,20 @@ gh-tldr
 
 ### Direct Mode
 
-Use flags for scripting:
-
 ```bash
-# Basic usage
-gh-tldr --days 7 --english
-
-# All options
 gh-tldr [username] [options]
-
-Options:
-  -d, --days <n>       Time period in days (default: 1)
-  -e, --english        Output in English (default: German)
-  -f, --format <type>  Output format: plain|markdown|slack (default: slack)
-  -p, --public-only    Exclude private repositories
-  -m, --model <model>  Claude model (e.g., haiku, sonnet, opus)
-  -i, --interactive    Force interactive mode
-  -h, --help           Show help
 ```
 
+| Option | Description |
+|--------|-------------|
+| `-d, --days <n>` | Time period in days (default: 1) |
+| `-e, --english` | Output in English (default: German) |
+| `-f, --format <type>` | Output: `plain` \| `markdown` \| `slack` |
+| `-p, --public-only` | Exclude private repositories |
+| `-m, --model <model>` | Claude model (e.g., haiku, sonnet, opus) |
+| `-i, --interactive` | Force interactive mode |
+| `-h, --help` | Show help |
+
 ### Examples
 
 ```bash
@@ -111,7 +137,7 @@ gh-tldr --model haiku
 gh-tldr --days 30 --format markdown
 ```
 
-## Output
+## Example Output
 
 ```
 tl;dr 28.12.2025
@@ -132,15 +158,24 @@ Did several code reviews for the team, including the new API endpoint.
 ## Development
 
 ```bash
-# Run in dev mode
-pnpm dev
+pnpm dev        # Run in dev mode
+pnpm build      # Build
+pnpm typecheck  # Type check
+```
 
-# Build
-pnpm build
+## Contributing
 
-# Type check
-pnpm typecheck
-```
+Issues and PRs welcome! See [open issues](https://github.com/yungweng/gh-tldr/issues).
+
+## Links
+
+- [Repository](https://github.com/yungweng/gh-tldr)
+- [Issues](https://github.com/yungweng/gh-tldr/issues)
+- [npm](https://www.npmjs.com/package/gh-tldr)
+
+## Author
+
+Maintained by [@yungweng](https://github.com/yungweng)
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gh-tldr",
-  "version": "1.0.8",
+  "version": "1.0.10",
   "description": "Generate a TL;DR summary of your GitHub activity",
   "type": "module",
   "main": "dist/index.js",
@@ -25,9 +25,14 @@
     "cli",
     "tldr",
     "activity",
-    "summary"
+    "summary",
+    "claude",
+    "ai",
+    "anthropic",
+    "standup",
+    "productivity"
   ],
-  "author": "",
+  "author": "yungweng",
   "license": "MIT",
   "repository": {
     "type": "git",