Skip to content

Commit

Permalink
docs: reworks README to be outcome based (#151)
Browse files Browse the repository at this point in the history
Signed-off-by: Adrian Cole <adrian.cole@elastic.co>
Co-authored-by: Michael Neale <michael.neale@gmail.com>
Co-authored-by: lily-de <119957291+lily-de@users.noreply.github.com>
  • Loading branch information
3 people authored and ahau-square committed Nov 6, 2024
1 parent 01d70b5 commit aab356b
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h1 align="center">
Goose is your on-machine developer agent, automating engineering tasks seamlessly within your IDE or terminal
Goose is your on-machine developer agent, working for you, on your terms
</h1>

<p align="center">
Expand Down Expand Up @@ -37,7 +37,20 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl
> pipx install goose-ai
> ```
**Goose** is a developer agent that supercharges your software development by automating an array of coding tasks directly within your terminal or IDE. Guided by you, it can intelligently assess your project's needs, generate the required code or modifications, and implement these changes on its own. Goose can **interact with a multitude of tools via external APIs** such as Jira, GitHub, Slack, infrastructure and data pipelines, and more -- if your task uses a **shell command or can be carried out by a Python script, Goose can do it for you too!** Like semi-autonomous driving, Goose handles the heavy lifting, allowing you to focus on other priorities. Simply set it on a task and return later to find it completed, boosting your productivity with less manual effort.
Each day, we have tasks that stretch our days. Maybe it is completing that half-complete change started by someone now
on holiday, or figuring out the tl;dr; of that 50 comment pull request. Wouldn't it be grand if someone else can do
this, or at least start the work for us?
**Goose** is your on-machine developer agent, working for you, on your terms. Guided by you, Goose intelligently
assesses what you need and generates required code or modifications. You are in charge: Do you prefer Goose to make a
draft, or complete the change entirely? Do you prefer to work in a terminal or in your IDE?
Doing our work requires a lot of tools like Jira, GitHub, Slack, as well APIs for infrastructure and data pipelines.
Goose handles all of these, and is extensible. Goose can run anything invokable by a shell command, Python or a plugin.
Like semi-autonomous driving, Goose handles the heavy lifting, allowing you to focus on other priorities. Simply set it
on a task and return later to find it completed, boosting your productivity with less manual effort. Read on to get
started!
<p align="center">
<video src="https://github.com/user-attachments/assets/63ee7910-cb02-45c0-9982-351cbce83925" width="700" height="700" />
Expand Down

0 comments on commit aab356b

Please sign in to comment.