Skip to content

Commit b003b26

Browse files
committed
README updates
1 parent 5c35db9 commit b003b26

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@ libtmux - library for managing tmux workspaces
22

33
|pypi| |docs| |build-status| |coverage| |license|
44

5+
libtmux is the library the powers `tmuxp`_, a tool that helps tmux users
6+
manage their tmux workspaces.
7+
8+
Take control of tmux via python.
9+
10+
View the `documentation`_ homepage, `API`_ information and `architectural
11+
details`_.
12+
13+
.. _tmuxp: https://github.com/tony/tmuxp
14+
.. _documentation: https://libtmux.readthedocs.io/
15+
.. _API: https://libtmux.readthedocs.io/api.html
16+
.. _architectural details: https://libtmux.readthedocs.io/internals.html
17+
518
install
619
-------
720

@@ -76,6 +89,13 @@ send key strokes to panes::
7689
>>> pane.send_keys('echo hey', enter=False)
7790
>>> pane.enter()
7891

92+
powerful traversal features::
93+
94+
>>> pane.window
95+
Window(@10 1:libtmuxower, Session($3 a_libtmux_session))
96+
>>> pane.window.session
97+
Session($3 a_libtmux_session)
98+
7999
Project details
80100
---------------
81101

0 commit comments

Comments
 (0)