Commit c6c1361
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 implementation1 parent d14fc75 commit c6c1361
2 files changed
Lines changed: 172 additions & 344 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
| 5 | + | |
5 | 6 | | |
6 | | - | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
7 | 10 | | |
0 commit comments