From a2eb7a3b0a67090502bd9270d741b3503b9a9cbc Mon Sep 17 00:00:00 2001 From: Mark Allen Date: Tue, 5 Aug 2025 13:05:05 +0100 Subject: [PATCH 1/2] feat: enhance README with demo video and promotional content - Add inline video demo section with HTML5 video tag and fallback link - Enhance header with additional badges (Ruby version, Docker support) - Improve tagline with compelling value proposition messaging - Add Quick Start section for faster onboarding experience - Expand Features section with detailed descriptions and benefits - Include "Why Use This Tool?" section highlighting key advantages - Reference live example in Issue #12 for real-world demonstration - Restructure content flow for better user engagement and conversion This significantly improves the project's presentation and should help attract more users by clearly demonstrating the tool's value and making the setup process appear more approachable. --- README.md | 44 +++++++++++++++++++++++++++++++++++++++----- 1 file changed, 39 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bdf4c83..1122d13 100644 --- a/README.md +++ b/README.md @@ -2,24 +2,58 @@ [![CI](https://github.com/markhallen/slack-github-threads/actions/workflows/ci.yml/badge.svg)](https://github.com/markhallen/slack-github-threads/actions/workflows/ci.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![Ruby](https://img.shields.io/badge/Ruby-3.2+-red.svg)](https://www.ruby-lang.org/) +[![Docker](https://img.shields.io/badge/Docker-Ready-blue.svg)](https://www.docker.com/)

Slack GitHub Threads Logo

-A Slack slash command integration that posts Slack thread conversations as comments to GitHub issues. +**🚀 Bridge the gap between Slack discussions and GitHub issues** + +A powerful Slack integration that seamlessly exports thread conversations as formatted comments to GitHub issues. Perfect for development teams who discuss features, bugs, and decisions in Slack but need to document them in GitHub. ## Overview This Ruby Sinatra application provides a bridge between Slack and GitHub, allowing you to easily share Slack thread discussions as comments on GitHub issues. When you use the slash command with a GitHub issue URL, it will collect all messages in the current thread and post them as a formatted comment to the specified GitHub issue. +## 🎬 Demo + +See the tool in action! This demo shows how a Slack thread conversation gets beautifully formatted and posted to a GitHub issue: + + + +**📋 Live Example**: Check out [Issue #12](https://github.com/markhallen/slack-github-threads/issues/12) to see a real Slack thread that was exported using this tool. + +## ⚡ Quick Start + +Ready to get started? Here's the fastest way to set up slack-github-threads: + +1. **Create your Slack app** using our [app manifest](docs/app-manifest.json) (just 2 minutes!) +2. **Deploy to your server** or run locally with Docker +3. **Start exporting threads** with `/ghcomment [github-issue-url]` + +👉 **New to this?** Follow our [detailed setup guide](#installation) for step-by-step instructions. + ## Features -- 🔗 **Slack Integration**: Works as a Slack slash command -- 📝 **Thread Collection**: Captures entire Slack thread conversations -- 🐙 **GitHub Integration**: Posts formatted comments to GitHub issues -- 🚀 **Easy Deployment**: Configured for deployment with Kamal +- 🔗 **Slack Integration**: Works seamlessly as a Slack slash command and shortcuts +- 📝 **Thread Collection**: Captures entire Slack thread conversations with user attribution +- 🐙 **GitHub Integration**: Posts beautifully formatted comments to GitHub issues +- ⚡ **Instant Setup**: One-click app creation using Slack app manifest +- 🚀 **Easy Deployment**: Configured for deployment with Kamal or Docker - 🔒 **Secure**: Uses environment variables for sensitive tokens +- 🎯 **Smart Formatting**: Preserves message structure, usernames, and timestamps +- 📱 **Multiple Interfaces**: Slash commands, message shortcuts, and global shortcuts + +### Why Use This Tool? + +- **Bridge Communication Gaps**: Seamlessly move Slack discussions to GitHub where they belong +- **Preserve Context**: Keep the conversational flow and user attribution intact +- **Save Time**: No more copy-pasting individual messages or losing discussion context +- **Team Collaboration**: Make Slack conversations accessible to your entire development team ## Prerequisites From b78ace5cc8a620f46840babc97ed50ad490f1bd8 Mon Sep 17 00:00:00 2001 From: Mark Allen Date: Tue, 5 Aug 2025 13:27:38 +0100 Subject: [PATCH 2/2] fix: update demo video section in README for clarity --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 1122d13..c3656fd 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,7 @@ This Ruby Sinatra application provides a bridge between Slack and GitHub, allowi See the tool in action! This demo shows how a Slack thread conversation gets beautifully formatted and posted to a GitHub issue: - +https://github.com/user-attachments/assets/259b82d4-6575-4345-928b-ddbaed87420a **📋 Live Example**: Check out [Issue #12](https://github.com/markhallen/slack-github-threads/issues/12) to see a real Slack thread that was exported using this tool.