aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorjaseg <git@jaseg.net>2018-07-20 17:12:54 +0200
committerjaseg <git@jaseg.net>2018-07-20 17:12:54 +0200
commitf3bcb6c4c5c4fee81a5c8eccbe915e781872f57c (patch)
tree01a5e53f6d9998857c27c55ab4965594b4b9d470 /README.rst
downloadnyanping-f3bcb6c4c5c4fee81a5c8eccbe915e781872f57c.tar.gz
nyanping-f3bcb6c4c5c4fee81a5c8eccbe915e781872f57c.tar.bz2
nyanping-f3bcb6c4c5c4fee81a5c8eccbe915e781872f57c.zip
Initial commit
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst29
1 files changed, 29 insertions, 0 deletions
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
+