From b5a2eae38a9f1e240bfb8202888712bc0075b161 Mon Sep 17 00:00:00 2001
From: Angie Jones <jones.angie@gmail.com>
Date: Fri, 21 Feb 2025 18:23:03 -0600
Subject: [PATCH] updates to readme and contributing guides (#1339)

---
 CONTRIBUTING.md | 29 +++++++++++++++++++----------
 README.md       | 36 +++++++++++++++++++++++-------------
 2 files changed, 42 insertions(+), 23 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 469913539..31be8ab4f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,16 +1,10 @@
 # Contribution Guide
 
-Goose is Open Source! There are numerous ways to be an open source contributor and contribute to Goose. We're here to help you on your way! Here are some suggestions to get started. If you have any questions or need help, feel free to reach out to us on [Discord](https://discord.gg/block-opensource).
+Goose is open source! 
 
-- **Stars on GitHub:** If you resonate with our project and find it valuable, consider starring our Goose on GitHub! 🌟
-- **Ask Questions:** Your questions not only help us improve but also benefit the community. If you have a question, don't hesitate to ask it on [Discord](https://discord.gg/block-opensource).
-- **Give Feedback:** Have a feature you want to see or encounter an issue with Goose, [click here to open an issue](https://github.com/block/goose/issues/new/choose), [start a discussion](https://github.com/block/goose/discussions) or tell us on Discord.
-- **Participate in Community Events:** We host a variety of community events and livestreams on Discord every month, ranging from workshops to brainstorming sessions. You can subscribe to our [events calendar](https://calget.com/c/t7jszrie) or follow us on [social media](https://linktr.ee/blockopensource) to stay in touch.
-- **Improve Documentation:** Good documentation is key to the success of any project. You can help improve the quality of our existing docs or add new pages.
-- **Help Other Members** See another community member stuck? Or a contributor blocked by a question you know the answer to? Reply to community threads or do a code review for others to help.
-- **Showcase Your Work:** Working on a project or written a blog post recently? Share it with the community in our [#share-your-work](https://discord.com/channels/1287729918100246654/1287729920797179958) channel.
-- **Give Shoutouts:** Is there a project you love or a community/staff who's been especially helpful? Feel free to give them a shoutout in our [#general](https://discord.com/channels/1287729918100246654/1287729920797179957) channel.
-- **Spread the Word:** Help us reach more people by sharing Goose's project, website, YouTube, and/or Twitter/X.
+We welcome pull requests for general contributions! If you have a larger new feature or any questions on how to develop a fix, we recommend you open an issue before starting.
+
+>[!TIP] Beyond code, check out [other ways to contribute](#other-ways-to-contribute)
 
 ## Prerequisites
 
@@ -154,3 +148,18 @@ This project follows the [Conventional Commits](https://www.conventionalcommits.
 [rustup]: https://doc.rust-lang.org/cargo/getting-started/installation.html
 [nvm]: https://github.com/nvm-sh/nvm
 [just]: https://github.com/casey/just?tab=readme-ov-file#installation
+
+
+## Other Ways to Contribute
+
+There are numerous ways to be an open source contributor and contribute to Goose. We're here to help you on your way! Here are some suggestions to get started. If you have any questions or need help, feel free to reach out to us on [Discord](https://discord.gg/block-opensource).
+
+- **Stars on GitHub:** If you resonate with our project and find it valuable, consider starring our Goose on GitHub! 🌟
+- **Ask Questions:** Your questions not only help us improve but also benefit the community. If you have a question, don't hesitate to ask it on [Discord](https://discord.gg/block-opensource).
+- **Give Feedback:** Have a feature you want to see or encounter an issue with Goose, [click here to open an issue](https://github.com/block/goose/issues/new/choose), [start a discussion](https://github.com/block/goose/discussions) or tell us on Discord.
+- **Participate in Community Events:** We host a variety of community events and livestreams on Discord every month, ranging from workshops to brainstorming sessions. You can subscribe to our [events calendar](https://calget.com/c/t7jszrie) or follow us on [social media](https://linktr.ee/blockopensource) to stay in touch.
+- **Improve Documentation:** Good documentation is key to the success of any project. You can help improve the quality of our existing docs or add new pages.
+- **Help Other Members** See another community member stuck? Or a contributor blocked by a question you know the answer to? Reply to community threads or do a code review for others to help.
+- **Showcase Your Work:** Working on a project or written a blog post recently? Share it with the community in our [#share-your-work](https://discord.com/channels/1287729918100246654/1287729920797179958) channel.
+- **Give Shoutouts:** Is there a project you love or a community/staff who's been especially helpful? Feel free to give them a shoutout in our [#general](https://discord.com/channels/1287729918100246654/1287729920797179957) channel.
+- **Spread the Word:** Help us reach more people by sharing Goose's project, website, YouTube, and/or Twitter/X.
\ No newline at end of file
diff --git a/README.md b/README.md
index b16db7d37..722ec9cc6 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,8 @@
-<h1 align="center">
-codename goose
-</h1>
+<div align="center">
 
-<p align="center">
-  <strong>an open-source, extensible AI agent that goes beyond code suggestions<br>install, execute, edit, and test with any LLM</strong>
-</p>
+# codename goose
+
+_a local, extensible, open source AI agent that automates engineering tasks_
 
 <p align="center">
   <a href="https://opensource.org/licenses/Apache-2.0">
@@ -17,14 +15,26 @@ codename goose
      <img src="https://img.shields.io/github/actions/workflow/status/block/goose/ci.yml?branch=main" alt="CI">
   </a>
 </p>
+</div>
+
+goose is your on-machine AI engineer, capable of automating complex development tasks from start to finish. More than just code suggestions, goose can build entire projects from scratch, write and execute code, debug failures, orchestrate workflows, and interact with external APIs - _autonomously_.
+
+Whether you're prototyping an idea, refining existing code, or managing intricate engineering pipelines, goose adapts to your workflow and executes tasks with precision.
+
+Designed for maximum flexibility, goose works with any LLM and seamlessly integrates with MCP-enabled APIs, making it the ultimate AI-powered assistant for developers who want to move faster and focus on innovation. 
+
 
 # Quick Links
-Check out our [documentation](https://block.github.io/goose), or to try it out head to the [installation](https://block.github.io/goose/docs/getting-started/installation) instructions!
+- [Quickstart](https://block.github.io/goose/docs/quickstart)
+- [Installation](https://block.github.io/goose/docs/getting-started/installation)
+- [Tutorials](https://block.github.io/goose/docs/category/tutorials)
+- [Documentation](https://block.github.io/goose/docs/category/getting-started)
+
 
 # Goose Around with Us
-- Join our community on [Discord](https://discord.gg/block-opensource)
-- Catch our weekly livestreams on [YouTube](https://www.youtube.com/@blockopensource)
-- Follow us on [LinkedIn](https://www.linkedin.com/company/block-opensource)
-- Tweet at us on [Twitter/X](https://x.com/blockopensource)
-- Chat with us on [Bluesky](https://bsky.app/profile/opensource.block.xyz)
-- Keep up on [Nostr](https://njump.me/opensource@block.xyz)
\ No newline at end of file
+- [Discord](https://discord.gg/block-opensource)
+- [YouTube](https://www.youtube.com/@blockopensource)
+- [LinkedIn](https://www.linkedin.com/company/block-opensource)
+- [Twitter/X](https://x.com/blockopensource)
+- [Bluesky](https://bsky.app/profile/opensource.block.xyz)
+- [Nostr](https://njump.me/opensource@block.xyz)
\ No newline at end of file