diff --git a/README.md b/README.md index e6ee0fd3..b45756b8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Automata: The Future is Self-Written -![Banner](./automata_banner.png) +![Banner](https://github.com/emrgnt-cmplxty/Automata/assets/68796651/61fe3c33-9b7a-4c1b-9726-a77140476b83) [![codecov](https://codecov.io/github/emrgnt-cmplxty/Automata/branch/main/graph/badge.svg?token=ZNE7RDUJQD)](https://codecov.io/github/emrgnt-cmplxty/Automata) [![Documentation Status](https://readthedocs.org/projects/automata/badge/?version=latest)](https://automata.readthedocs.io/en/latest/?badge=latest) @@ -14,8 +14,6 @@ This project is inspired by the theory that code is essentially a form of memory --- -## 🧠 [Read the Docs](https://automata.readthedocs.io/en/latest/) - ## Demo https://github.com/emrgnt-cmplxty/Automata/assets/68796651/2e1ceb8c-ac93-432b-af42-c383ea7607d7 @@ -30,6 +28,8 @@ https://github.com/emrgnt-cmplxty/Automata/assets/68796651/2e1ceb8c-ac93-432b-af ## Installation and Usage +### 🧠 [Stuck? Try the Docs](https://automata.readthedocs.io/en/latest/) + ### Initial Setup Follow these steps to setup the Automata environment @@ -94,7 +94,7 @@ Automata works by combining Large Language Models, such as GPT-4, with a vector Automata employs downstream tooling to execute advanced coding tasks, continually building its expertise and autonomy. This self-coding approach mirrors an autonomous craftsman's work, where tools and techniques are consistently refined based on feedback and accumulated experience. -### Example - Running your own agent +### Example - Building your own agent Sometimes the best way to understand a complicated system is to start by understanding a basic example. The following example illustrates how to run your own Automata agent. The agent will be initialized with a trivial instruction, and will then attempt to write code to fulfill the instruction. The agent will then return the result of its attempt.