Skip to content

docs: add root README.md for monorepo#52

Merged
rianjs merged 1 commit intomainfrom
docs/43-root-readme
Jan 31, 2026
Merged

docs: add root README.md for monorepo#52
rianjs merged 1 commit intomainfrom
docs/43-root-readme

Conversation

@rianjs
Copy link
Copy Markdown
Contributor

@rianjs rianjs commented Jan 31, 2026

Summary

  • Add consolidated README.md at repository root
  • Include table of contents, tools overview, and installation instructions
  • Document shared credentials with ATLASSIAN_* environment variables
  • Provide brief command examples for both jtk and cfl
  • Link to detailed tool-specific READMEs

Structure

  • Tools overview table
  • Installation (Homebrew, Chocolatey, Winget, APT/RPM, source)
  • Getting Started (config, auth, shared credentials)
  • jtk overview with common commands
  • cfl overview with common commands
  • Shell completion
  • Development guide
  • Contributing

Closes #43

🤖 Generated with Claude Code

Create consolidated documentation at repository root with:
- Table of contents
- Tools overview table with links to detailed docs
- Installation instructions for all platforms (Homebrew, Chocolatey, Winget, APT/RPM)
- Getting started guide (configuration, authentication, shared credentials)
- Brief overviews of jtk and cfl with common commands
- Shell completion instructions
- Development guide for the monorepo
- Contributing guidelines

Individual tool READMEs remain as exhaustive command references.

Closes #43

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@rianjs rianjs merged commit f7c04cf into main Jan 31, 2026
7 checks passed
@rianjs rianjs deleted the docs/43-root-readme branch January 31, 2026 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: create root README.md for monorepo

1 participant