Skip to content

docs: update the readme with more details#63

Merged
andrewb1269 merged 1 commit intomainfrom
58-fix-add-more-details-to-readme-clean-up-formatting
May 1, 2025
Merged

docs: update the readme with more details#63
andrewb1269 merged 1 commit intomainfrom
58-fix-add-more-details-to-readme-clean-up-formatting

Conversation

@andrewb1269
Copy link
Copy Markdown
Contributor

No description provided.

Signed-off-by: Andrew Brandt <andrew.brandt@hashgraph.com>
@andrewb1269 andrewb1269 self-assigned this May 1, 2025
@andrewb1269 andrewb1269 linked an issue May 1, 2025 that may be closed by this pull request
@rbarker-dev rbarker-dev requested a review from Copilot May 1, 2025 17:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the README to provide more detailed installation, setup, and usage instructions for the CLI tool.

  • Enhanced the "Getting Started" section with emojis for improved visual structure.
  • Added dedicated sections for Requirements, Setup, Usage, Background, and the Solution.
Comments suppressed due to low confidence (1)

README.md:30

  • [nitpick] Consider clarifying the phrasing 'can only automate with a single organization'. Rewording to state that project boards are limited to a single organization could improve clarity.
Project board can only automate with a single organization, meaning users who work in more than one org do not have a single location to view all issues.

@andrewb1269 andrewb1269 merged commit dd418b7 into main May 1, 2025
5 checks passed
@andrewb1269 andrewb1269 deleted the 58-fix-add-more-details-to-readme-clean-up-formatting branch May 1, 2025 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: add more details to readme, clean up formatting

3 participants