diff --git a/README.md b/README.md
index efd324b67..8a8e3bbe7 100644
--- a/README.md
+++ b/README.md
@@ -1,51 +1,99 @@
-# libtmux
+
+
⚙️ libtmux
+
Drive tmux from Python: typed, object-oriented control over servers, sessions, windows, and panes.
+
+
+
+
+
+
+
+
+
+
+
-`libtmux` is a [typed](https://docs.python.org/3/library/typing.html) Python library that provides a wrapper for interacting programmatically with tmux, a terminal multiplexer. You can use it to manage tmux servers,
-sessions, windows, and panes. Additionally, `libtmux` powers [tmuxp], a tmux workspace manager.
+## 🐍 What is libtmux?
-[](https://pypi.org/project/libtmux/)
-[](https://libtmux.git-pull.com/)
-[](https://github.com/tmux-python/libtmux/actions?query=workflow%3A%22tests%22)
-[](https://codecov.io/gh/tmux-python/libtmux)
-[](https://github.com/tmux-python/libtmux/blob/master/LICENSE)
+libtmux is a typed Python API over [tmux], the terminal multiplexer. Stop shelling out and parsing `tmux ls`. Instead, interact with real Python objects: `Server`, `Session`, `Window`, and `Pane`. The same API powers [tmuxp], so it stays battle-tested in real-world workflows.
-libtmux builds upon tmux's
-[target](http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#COMMANDS) and
-[formats](http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#FORMATS) to
-create an object mapping to traverse, inspect and interact with live
-tmux sessions.
+### ✨ Features
-View the [documentation](https://libtmux.git-pull.com/),
-[API](https://libtmux.git-pull.com/api.html) information and
-[architectural details](https://libtmux.git-pull.com/about.html).
+- Typed, object-oriented control of tmux state
+- Query and [traverse](https://libtmux.git-pull.com/topics/traversal.html) live sessions, windows, and panes
+- Raw escape hatch via `.cmd(...)` on any object
+- Works with multiple tmux sockets and servers
+- [Context managers](https://libtmux.git-pull.com/topics/context_managers.html) for automatic cleanup
+- [pytest plugin](https://libtmux.git-pull.com/pytest-plugin/index.html) for isolated tmux fixtures
+- Proven in production via tmuxp and other tooling
-# Install
+## Requirements & support
-```console
-$ pip install --user libtmux
+- tmux: >= 3.2a
+- Python: >= 3.10 (CPython and PyPy)
+
+Maintenance-only backports (no new fixes):
+
+- Python 2.x: [`v0.8.x`](https://github.com/tmux-python/libtmux/tree/v0.8.x)
+- tmux 1.8-3.1c: [`v0.48.x`](https://github.com/tmux-python/libtmux/tree/v0.48.x)
+
+## 📦 Installation
+
+Stable release:
+
+```bash
+pip install libtmux
```
-# Open a tmux session
+With pipx:
-Session name `foo`, window name `bar`
+```bash
+pipx install libtmux
+```
-```console
-$ tmux new-session -s foo -n bar
+With uv / uvx:
+
+```bash
+uv add libtmux
+uvx --from "libtmux" python
```
-# Pilot your tmux session via python
+From the main branch (bleeding edge):
-```console
-$ python
+```bash
+pip install 'git+https://github.com/tmux-python/libtmux.git'
+```
+
+Tip: libtmux is pre-1.0. Pin a range in projects to avoid surprises:
+
+requirements.txt:
+
+```ini
+libtmux==0.49.*
+```
+
+pyproject.toml:
+
+```toml
+libtmux = "0.49.*"
```
-Use [ptpython], [ipython], etc. for a nice shell with autocompletions:
+## 🚀 Quickstart
+
+### Open a tmux session
+
+First, start a tmux session to connect to:
```console
-$ pip install --user ptpython
+$ tmux new-session -s foo -n bar
```
+### Pilot your tmux session via Python
+
+Use [ptpython], [ipython], etc. for a nice REPL with autocompletions:
+
```console
+$ pip install --user ptpython
$ ptpython
```
@@ -58,17 +106,16 @@ Connect to a live tmux session:
Server(socket_path=/tmp/tmux-.../default)
```
-Tip: You can also use [tmuxp]'s [`tmuxp shell`] to drop straight into your
-current tmux server / session / window pane.
+**Tip:** You can also use [tmuxp]'s [`tmuxp shell`] to drop straight into your
+current tmux server / session / window / pane.
-[tmuxp]: https://tmuxp.git-pull.com/
-[`tmuxp shell`]: https://tmuxp.git-pull.com/cli/shell.html
[ptpython]: https://github.com/prompt-toolkit/ptpython
[ipython]: https://ipython.org/
+[`tmuxp shell`]: https://tmuxp.git-pull.com/cli/shell.html
-Run any tmux command, respective of context:
+### Run any tmux command
-Honors tmux socket name and path:
+Every object has a `.cmd()` escape hatch that honors socket name and path:
```python
>>> server = Server(socket_name='libtmux_doctest')
@@ -76,205 +123,201 @@ Honors tmux socket name and path:
```
-New session:
+Create a new session:
```python
>>> server.cmd('new-session', '-d', '-P', '-F#{session_id}').stdout[0]
-'$2'
-```
-
-```python
->>> session.cmd('new-window', '-P').stdout[0]
-'libtmux...:2.0'
-```
-
-From raw command output, to a rich `Window` object (in practice and as shown
-later, you'd use `Session.new_window()`):
-
-```python
->>> Window.from_window_id(window_id=session.cmd('new-window', '-P', '-F#{window_id}').stdout[0], server=session.server)
-Window(@2 2:..., Session($1 libtmux_...))
+'$...'
```
-Create a pane from a window:
+### List and filter sessions
-```python
->>> window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0]
-'%2'
-```
-
-Raw output directly to a `Pane`:
-
-```python
->>> Pane.from_pane_id(pane_id=window.cmd('split-window', '-P', '-F#{pane_id}').stdout[0], server=window.server)
-Pane(%... Window(@1 1:..., Session($1 libtmux_...)))
-```
-
-List sessions:
+[**Learn more about Filtering**](https://libtmux.git-pull.com/topics/filtering.html)
```python
>>> server.sessions
-[Session($1 ...), Session($0 ...)]
+[Session($... ...), ...]
```
-Filter sessions by attribute:
+Filter by attribute:
```python
>>> server.sessions.filter(history_limit='2000')
-[Session($1 ...), Session($0 ...)]
+[Session($... ...), ...]
```
Direct lookup:
```python
->>> server.sessions.get(session_id="$1")
-Session($1 ...)
+>>> server.sessions.get(session_id=session.session_id)
+Session($... ...)
```
-Filter sessions:
+### Control sessions and windows
-```python
->>> server.sessions[0].rename_session('foo')
-Session($1 foo)
->>> server.sessions.filter(session_name="foo")
-[Session($1 foo)]
->>> server.sessions.get(session_name="foo")
-Session($1 foo)
-```
-
-Control your session:
+[**Learn more about Workspace Setup**](https://libtmux.git-pull.com/topics/workspace_setup.html)
```python
->>> session
-Session($1 ...)
-
>>> session.rename_session('my-session')
-Session($1 my-session)
+Session($... my-session)
```
Create new window in the background (don't switch to it):
```python
->>> bg_window = session.new_window(attach=False, window_name="ha in the bg")
+>>> bg_window = session.new_window(attach=False, window_name="bg-work")
>>> bg_window
-Window(@... 2:ha in the bg, Session($1 ...))
+Window(@... ...:bg-work, Session($... ...))
-# Session can search the window
->>> session.windows.filter(window_name__startswith="ha")
-[Window(@... 2:ha in the bg, Session($1 ...))]
+>>> session.windows.filter(window_name__startswith="bg")
+[Window(@... ...:bg-work, Session($... ...))]
-# Directly
->>> session.windows.get(window_name__startswith="ha")
-Window(@... 2:ha in the bg, Session($1 ...))
+>>> session.windows.get(window_name__startswith="bg")
+Window(@... ...:bg-work, Session($... ...))
-# Clean up
>>> bg_window.kill()
```
-Close window:
-
-```python
->>> w = session.active_window
->>> w.kill()
-```
-
-Grab remaining tmux window:
-
-```python
->>> window = session.active_window
->>> window.split(attach=False)
-Pane(%2 Window(@1 1:... Session($1 ...)))
-```
-
-Rename window:
-
-```python
->>> window.rename_window('libtmuxower')
-Window(@1 1:libtmuxower, Session($1 ...))
-```
+### Split windows and send keys
-Split window (create a new pane):
+[**Learn more about Pane Interaction**](https://libtmux.git-pull.com/topics/pane_interaction.html)
```python
->>> pane = window.split()
->>> pane = window.split(attach=False)
->>> pane.select()
-Pane(%3 Window(@1 1:..., Session($1 ...)))
->>> window = session.new_window(attach=False, window_name="test")
->>> window
-Window(@2 2:test, Session($1 ...))
>>> pane = window.split(attach=False)
>>> pane
-Pane(%5 Window(@2 2:test, Session($1 ...)))
+Pane(%... Window(@... ...:..., Session($... ...)))
```
-Type inside the pane (send key strokes):
+Type inside the pane (send keystrokes):
```python
->>> pane.send_keys('echo hey send now')
-
+>>> pane.send_keys('echo hello')
>>> pane.send_keys('echo hey', enter=False)
>>> pane.enter()
-Pane(%1 ...)
+Pane(%... ...)
```
-Grab the output of pane:
+### Capture pane output
```python
->>> pane.clear() # clear the pane
-Pane(%1 ...)
->>> pane.send_keys("cowsay 'hello'", enter=True)
->>> print('\n'.join(pane.cmd('capture-pane', '-p').stdout)) # doctest: +SKIP
-$ cowsay 'hello'
- _______
-< hello >
- -------
- \ ^__^
- \ (oo)\_______
- (__)\ )\/\
- ||----w |
- || ||
-...
+>>> pane.clear()
+Pane(%... ...)
+>>> pane.send_keys("echo 'hello world'", enter=True)
+>>> pane.cmd('capture-pane', '-p').stdout # doctest: +SKIP
+["$ echo 'hello world'", 'hello world', '$']
```
-Traverse and navigate:
+### Traverse the hierarchy
+
+[**Learn more about Traversal**](https://libtmux.git-pull.com/topics/traversal.html)
+
+Navigate from pane up to window to session:
```python
>>> pane.window
-Window(@1 1:..., Session($1 ...))
+Window(@... ...:..., Session($... ...))
>>> pane.window.session
-Session($1 ...)
+Session($... ...)
```
-# Backports
+## Core concepts
-Unsupported / no security releases or bug fixes:
+| libtmux object | tmux concept | Notes |
+|----------------|-----------------------------|--------------------------------|
+| [`Server`](https://libtmux.git-pull.com/api/servers.html) | tmux server / socket | Entry point; owns sessions |
+| [`Session`](https://libtmux.git-pull.com/api/sessions.html) | tmux session (`$0`, `$1`,...) | Owns windows |
+| [`Window`](https://libtmux.git-pull.com/api/windows.html) | tmux window (`@1`, `@2`,...) | Owns panes |
+| [`Pane`](https://libtmux.git-pull.com/api/panes.html) | tmux pane (`%1`, `%2`,...) | Where commands run |
-- Python 2.x: The backports branch is
- [`v0.8.x`](https://github.com/tmux-python/libtmux/tree/v0.8.x).
-- tmux 1.8 to 3.1c: The backports branch is
- [`v0.48.x`](https://github.com/tmux-python/libtmux/tree/v0.48.x).
+Also available: [`Options`](https://libtmux.git-pull.com/api/options.html) and [`Hooks`](https://libtmux.git-pull.com/api/hooks.html) abstractions for tmux configuration.
-# Donations
+Collections are live and queryable:
-Your donations fund development of new features, testing and support.
-Your money will go directly to maintenance and development of the
-project. If you are an individual, feel free to give whatever feels
-right for the value you get out of the project.
+```python
+server = libtmux.Server()
+session = server.sessions.get(session_name="demo")
+api_windows = session.windows.filter(window_name__startswith="api")
+pane = session.active_window.active_pane
+pane.send_keys("echo 'hello from libtmux'", enter=True)
+```
+
+## tmux vs libtmux vs tmuxp
+
+| Tool | Layer | Typical use case |
+|---------|----------------------------|----------------------------------------------------|
+| tmux | CLI / terminal multiplexer | Everyday terminal usage, manual control |
+| libtmux | Python API over tmux | Programmatic control, automation, testing |
+| tmuxp | App on top of libtmux | Declarative tmux workspaces from YAML / TOML |
-See donation options at .
+## Testing & fixtures
-# Project details
+[**Learn more about the pytest plugin**](https://libtmux.git-pull.com/pytest-plugin/index.html)
+
+Writing a tool that interacts with tmux? Use our fixtures to keep your tests clean and isolated.
+
+```python
+def test_my_tmux_tool(session):
+ # session is a real tmux session in an isolated server
+ window = session.new_window(window_name="test")
+ pane = window.active_pane
+ pane.send_keys("echo 'hello from test'", enter=True)
+
+ assert window.window_name == "test"
+ # Fixtures handle cleanup automatically
+```
-- tmux support: >= 3.2a
-- python support: >= 3.10, pypy, pypy3
-- Source:
-- Docs:
-- API:
-- Changelog:
-- Issues:
-- Test Coverage:
-- pypi:
-- Open Hub:
-- Repology:
-- License: [MIT](http://opensource.org/licenses/MIT).
+- Fresh tmux server/session/window/pane fixtures per test
+- Temporary HOME and tmux config fixtures keep indices stable
+- `TestServer` helper spins up multiple isolated tmux servers
+
+## When you might not need libtmux
+
+- Layouts are static and live entirely in tmux config files
+- You do not need to introspect or control running tmux from other tools
+- Python is unavailable where tmux is running
+
+## Project links
+
+**Topics:**
+[Traversal](https://libtmux.git-pull.com/topics/traversal.html) ·
+[Filtering](https://libtmux.git-pull.com/topics/filtering.html) ·
+[Pane Interaction](https://libtmux.git-pull.com/topics/pane_interaction.html) ·
+[Workspace Setup](https://libtmux.git-pull.com/topics/workspace_setup.html) ·
+[Automation Patterns](https://libtmux.git-pull.com/topics/automation_patterns.html) ·
+[Context Managers](https://libtmux.git-pull.com/topics/context_managers.html) ·
+[Options & Hooks](https://libtmux.git-pull.com/topics/options_and_hooks.html)
+
+**Reference:**
+[Docs][docs] ·
+[API][api] ·
+[pytest plugin](https://libtmux.git-pull.com/pytest-plugin/index.html) ·
+[Architecture][architecture] ·
+[Changelog][history] ·
+[Migration][migration]
+
+**Project:**
+[Issues][issues] ·
+[Coverage][coverage] ·
+[Releases][releases] ·
+[License][license] ·
+[Support][support]
+
+**[The Tao of tmux][tao]** — deep-dive book on tmux fundamentals
+
+## Contributing & support
+
+Contributions are welcome. Please open an issue or PR if you find a bug or want to improve the API or docs. If libtmux helps you ship, consider sponsoring development via [support].
+
+[docs]: https://libtmux.git-pull.com
+[api]: https://libtmux.git-pull.com/api.html
+[architecture]: https://libtmux.git-pull.com/about.html
+[history]: https://libtmux.git-pull.com/history.html
+[migration]: https://libtmux.git-pull.com/migration.html
+[issues]: https://github.com/tmux-python/libtmux/issues
+[coverage]: https://codecov.io/gh/tmux-python/libtmux
+[releases]: https://pypi.org/project/libtmux/
+[license]: https://github.com/tmux-python/libtmux/blob/master/LICENSE
+[support]: https://tony.sh/support.html
+[tao]: https://leanpub.com/the-tao-of-tmux
+[tmuxp]: https://tmuxp.git-pull.com
+[tmux]: https://github.com/tmux/tmux
diff --git a/docs/index.md b/docs/index.md
index 76c4796b6..341532ee9 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,19 +1,14 @@
----
-hide-toc: true
----
-
(index)=
-```{include} ../README.md
+# libtmux
+```{include} ../README.md
+:start-after:
```
-## Table of Contents
-
-:hidden:
-
```{toctree}
:maxdepth: 2
+:hidden:
quickstart
about