# AGENTS.md

Bidirectional and low-latency communication for every platform

## Setup

```
npm ci
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `packages/` 211 source files
- `examples/` 174 source files
- `docs/`     6 source files

## Conventions

- Tests live alongside the code they cover, following `examples/ReactNativeExample/__tests__/App.test.tsx`.
- CI defines what passing means. See `.github/workflows/build-examples.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `packages/socket.io/client-dist/socket.io.js` is 152KB. It will not fit comfortably in context, so read it in parts.

---

Drafted by agentreadme.com from what is in this repository. Everything marked TODO
needs a human. Check it in as AGENTS.md at the root.