From f3bcb6c4c5c4fee81a5c8eccbe915e781872f57c Mon Sep 17 00:00:00 2001
From: jaseg <git@jaseg.net>
Date: Fri, 20 Jul 2018 17:12:54 +0200
Subject: Initial commit

---
 README.rst | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.rst

(limited to 'README.rst')

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..f7cc812
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,29 @@
+Nyanping
+========
+
+Nyanping is an audio-visual ping utility that you can use when you need to diagnose connection problems while you're away from your computer. Or any other time. Just turn it on, and turn your volume up.
+
+Usage
+-----
+
+```
+$ nyanping heise.de
+```
+
+Pitch and speed will be proportional to the ping latency. In case of a timeout, the video pauses and resumes when connectivity is restored.
+
+Installation
+------------
+
+```
+$ pip install nyanping
+```
+
+Requirements
+------------
+
+* python
+* python-mpv
+* libmpv
+* youtube-dl
+
-- 
cgit