From 4eb105a75128a630868b8204ce2fa50252fc9bff Mon Sep 17 00:00:00 2001
From: jaseg <code@jaseg.net>
Date: Wed, 1 Apr 2020 14:27:27 +0200
Subject: Add some high-level API information to README

---
 README.rst | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'README.rst')

diff --git a/README.rst b/README.rst
index 6856fad..2cf347c 100644
--- a/README.rst
+++ b/README.rst
@@ -62,6 +62,9 @@ Usage
     import mpv
     player = mpv.MPV(ytdl=True)
     player.play('https://youtu.be/DOmdB7D-pUU')
+    player.wait_for_playback()
+
+python-mpv mostly exposes mpv's built-in API to python, adding only some porcelain on top. Most "`input commands <https://mpv.io/manual/master/#list-of-input-commands>`_" are mapped to methods of the MPV class. Check out these methods and their docstrings in `the source <https://github.com/jaseg/python-mpv/blob/master/mpv.py>`__ for things you can do. Additional controls and status information are exposed through `MPV properties <https://mpv.io/manual/master/#properties>`_. These can be accessed like ``player.metadata``, ``player.fullscreen`` and ``player.loop_playlist``.
 
 Threading
 ~~~~~~~~~
-- 
cgit