Skip to content

Commit c6c1361

Browse files
committed
fix: transform README to end-user focused and correct configuration
Major updates: - Changed title to emphasize Jira project connectivity - Added "What You Can Do" section with natural language examples - Added "Perfect For" section targeting specific user roles - Simplified Quick Start to 2-minute setup guide - Added comprehensive Real-World Examples section with emojis - FIXED incorrect ATLASSIAN_JIRA_URL reference to correct ATLASSIAN_SITE_NAME - Created user-friendly Troubleshooting section with common issues - Added detailed FAQ addressing user concerns about permissions, security, and compatibility - Removed technical transport modes and CLI command documentation - Added Support section for getting help - Updated .env.example with descriptive comments and API token generation link - Documented alternative config keys support (jira, atlassian-jira, etc.) - Verified all configuration against actual source code implementation
1 parent d14fc75 commit c6c1361

2 files changed

Lines changed: 172 additions & 344 deletions

File tree

.env.example

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# Enable debug logging
22
DEBUG=false
33

4-
# Atlassian Configuration
4+
# Atlassian Configuration (required for Jira access)
5+
# Your Jira site name (for https://your-instance.atlassian.net)
56
ATLASSIAN_SITE_NAME=your-instance
6-
ATLASSIAN_USER_EMAIL=your-email@example.com
7+
# Your Atlassian account email
8+
ATLASSIAN_USER_EMAIL=your-email@example.com
9+
# Your Atlassian API token (generate at https://id.atlassian.com/manage-profile/security/api-tokens)
710
ATLASSIAN_API_TOKEN=

0 commit comments

Comments
 (0)