Skip to content

Update README: Quick Links, Add Table of Contents, Community section, and fix typos #451

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README: Quick Links, Add Table of Contents, Community section, and fix typos #451

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9406b15
Add Discord community link with logo to README
VYaswanthKumar Oct 9, 2025
3b0c133
Merge branch 'main' into fix-sponsors-section
VYaswanthKumar Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@
>> **Track B (Remote)**: Open to everyone worldwide. 🏆 Prize: **Cash award**.
>>> 👉 Sign up here: [trycua.com/hackathon](https://www.trycua.com/hackathon)

## Table of Contents 🐨

- [Quick Links](#quick-links-)
- [Dark Mode Toggle](#dark-mode-toggle-coming-soon-)
- [Quick Start](#quick-start)
- [Usage](#usage-docs)
- [Computer SDK](#computer-docs)
- [Modules](#modules)
- [Resources](#resources)
- [Community](#community)
- [License](#license)
- [Contributing](#contributing)
- [Sponsors](#sponsors)


**cua** ("koo-ah") is Docker for [Computer-Use Agents](https://www.oneusefulthing.org/p/when-you-give-a-claude-a-mouse) - it enables AI agents to control full operating systems in virtual containers and deploy them locally or to the cloud.

<div align="center">
Expand Down Expand Up @@ -58,14 +73,15 @@ Missing a model? [Raise a feature request](https://github.com/trycua/cua/issues/

- [Get started with a Computer-Use Agent UI](https://docs.trycua.com/docs/quickstart-ui)
- [Get started with the Computer-Use Agent CLI](https://docs.trycua.com/docs/quickstart-cli)
- [Get started with the Python SDKs](https://docs.trycua.com/docs/quickstart-devs)
- [Get started with the Python SDKs](https://docs.trycua.com/docs/quickstart-dev)

<br/>

# Usage ([Docs](https://docs.trycua.com/docs))

```bash
pip install cua-agent[all]

```
```python
from agent import ComputerAgent
Expand Down Expand Up @@ -224,6 +240,28 @@ Thank you to all our supporters!

[![Stargazers over time](https://starchart.cc/trycua/cua.svg?variant=adaptive)](https://starchart.cc/trycua/cua)


## Sponsors

A big thank you to our amazing sponsors for supporting the CUA project!


## Quick Links 🔗

- [CUA Docs](https://docs.trycua.com)
- [Python SDK Quickstart](https://docs.trycua.com/docs/quickstart-devs)
- [Agent SDK Notebook Examples](https://github.com/trycua/cua/blob/main/notebooks/eval_osworld.ipynb)


## Community 💬

<div align="center">
<a href="https://discord.com/invite/mVnXXpdE85" target="_blank">
<img src="https://img.icons8.com/color/48/000000/discord-logo.png" alt="Discord Logo" width="40" height="40"/>
</a>
<p>Join our <a href="https://discord.com/invite/mVnXXpdE85">Discord community</a> to discuss ideas, get assistance, or share demos!</p>
</div>

## Sponsors

Thank you to all our [GitHub Sponsors](https://github.com/sponsors/trycua)!
Expand Down