Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme! #96

Merged
merged 9 commits into from
Sep 25, 2024
Merged

chore: update readme! #96

merged 9 commits into from
Sep 25, 2024

Conversation

lily-de
Copy link
Collaborator

@lily-de lily-de commented Sep 25, 2024

  1. README Changes:
    • Introduction Overhaul:
    • Updated the initial description to introduce Goose explicitly as an on-machine developer agent that automates engineering tasks.
    • Image and Media Integration:
    • Added a large Goose drawing with a caption explaining it's generated by Goose using the VincentVanCode toolkit.
    • Included a badge section with links to documentation, PyPI, license, and Discord.
    • Navigation and Tips:
    • Removed the old navigation list and replaced it with links to unique features, employee testimonials, quick start guide, and contribution sections.
    • Added a quick installation tip using pipx.
    • Unique Features and Testimonials:
    • Introduced sections detailing Goose's unique features compared to other AI assistants, such as autonomy and extensibility.
    • Added multiple testimonials from Block employees showcasing their positive experiences with Goose.
    • Quick Start Guide and Usage:
    • Simplified installation steps using pipx.
    • Updated the running instructions for starting, exiting, and resuming a Goose session.
    • Contribution and Involvement:
    • Encouraged contributions with links to good-first-issue tickets and the Contributing Guide.
    • Mentioned experimental integrations for VSCode and JetBrains IDEs and invited users to contribute to Goose Plugins.
    • Documentation and Links:
    • Added various links for documentation, toolkits, configurations, CLI commands, providers, use cases, and discussions.
  2. Additional Assets:
    • Introduced new binary assets:
    • A video file docs/assets/goose-in-action.mp4.
    • An image file docs/assets/goose.png.

(summary generated by Goose)

@lily-de lily-de marked this pull request as ready for review September 25, 2024 18:29
Copy link
Collaborator

@baxen baxen left a comment

Choose a reason for hiding this comment

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

LGTM!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@lily-de lily-de merged commit 2b6db66 into main Sep 25, 2024
2 checks passed
lifeizhou-ap added a commit that referenced this pull request Sep 25, 2024
* main:
  feat: add shell-completions subcommand (#76)
  chore: update readme! (#96)
  chore: update docs again (#77)
  fix: remove overly general match for long running commands (#87)
lily-de added a commit that referenced this pull request Oct 7, 2024
@lamchau lamchau deleted the ldelalande/read-me-version-2 branch October 24, 2024 11:45
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.

3 participants