diff --git a/README.md b/README.md index 0cfa50dd..6e42fade 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,10 @@ X.com +
+ + Powered by gptme +

diff --git a/docs/examples.rst b/docs/examples.rst index 0227ca1e..3db732c9 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -21,17 +21,32 @@ To see example output without running the commands yourself, check out the :doc: make test | gptme 'fix the failing tests' # if path not directly provided in prompt, it can read files using tools - gptme 'suggest improvements to my vimrc' + gptme 'explore' gptme 'take a screenshot and tell me what you see' + gptme 'suggest improvements to my vimrc' # can read URLs (if browser tool is available) gptme 'implement this' https://github.com/ErikBjare/gptme/issues/286 + # can use `gh` shell tool to read issues, PRs, etc. + gptme 'implement ErikBjare/gptme/issues/286' + + # create new projects + gptme 'create a performant n-body simulation in rust' + # chaining prompts + gptme 'make a change' - 'test it' - 'commit it' gptme 'show me something cool in the python repl' - 'something cooler' - 'something even cooler' Do you have a cool example? Share it with us in the `Discussions `_! +.. toctree:: + :maxdepth: 2 + :caption: More Examples + + demos + projects + .. rubric:: Skip confirmation and run in non-interactive mode diff --git a/docs/index.rst b/docs/index.rst index e2eff630..7de3e63a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,7 +20,6 @@ See the `README `_ fil getting-started examples - demos tools config providers diff --git a/docs/projects.rst b/docs/projects.rst new file mode 100644 index 00000000..2c4baa5a --- /dev/null +++ b/docs/projects.rst @@ -0,0 +1,67 @@ +Projects +======== + +This page lists projects that are powered by or built using gptme. + +Official Projects +----------------- + +* `gptme `_ + gptme itself, of course! + +* `gptme-agent-template `_ + Template for creating new agents powered by gptme. + +* `Bob `_ + The first agent built using the gptme agent architecture. + +* `gptme-rag `_ + RAG (Retrieval-Augmented Generation) implementation for gptme context management. + +* `gptme-webui `_ + Fancy web-based user interface for gptme, built with the help of `Lovable `_. + +Community Projects +------------------ + +*Your project could be here! Add it by creating a PR.* + +* `ErikBjare/nbody-sim `_ + Simple but performant n-body simulation in Rust built with gptme using only a few prompts. + + +.. rubric:: Adding Your Project + + +If you've built something using gptme, we'd love to feature it here! + +1. Add the "Built with gptme" badge to your README: + + .. code-block:: markdown + + [![built using gptme](https://img.shields.io/badge/built%20using-gptme%20%F0%9F%A4%96-5151f5?style=flat)](https://github.com/ErikBjare/gptme) + +2. Create a PR adding your project to this list: + + .. code-block:: rst + + * `Project Name `_ + Brief description of your project. + +.. rubric:: Built with gptme Badge + +The "Built with gptme" badge helps showcase your project's use of gptme and connects it to the broader ecosystem. + +Standard Badge (for projects built using gptme): + +.. image:: https://img.shields.io/badge/built%20using-gptme%20%F0%9F%A4%96-5151f5?style=flat + :target: https://github.com/ErikBjare/gptme + :alt: Built using gptme + +"Powered by" Variant (for tools/services running on gptme): + +.. image:: https://img.shields.io/badge/powered%20by-gptme%20%F0%9F%A4%96-5151f5?style=flat + :target: https://github.com/ErikBjare/gptme + :alt: Powered by gptme + +Use the standard badge for projects created with gptme's assistance, and the "powered by" variant for tools or services that run on gptme.