From df8ff385c88ac61b2803262508739a699cec66f8 Mon Sep 17 00:00:00 2001
From: "Javier S. Pedro" <javier@javispedro.com>
Date: Sun, 1 Jul 2012 18:13:59 +0200
Subject: updating readme, executable name

---
 README.md | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index b95d844..1df7e2f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,31 @@
 rodisc
 ======
 
-Remote optical disc service
\ No newline at end of file
+This very small and hacky daemon (done in ~2 hours) that will export all optical
+discs found in your Linux box (as detected by udisks) using the Apple DVD or CD
+Sharing protocol.
+
+Dependencies
+------------
+
+* GLib (recent, with GIO)
+* Avahi (avahi-gobject)
+* Libsoup
+* UDisks
+
+Usage
+-----
+
+For automatic mode just run the daemon.
+
+    ./rodiscd
+
+If you want to export image files in addition to your system's CD or DVD discs,
+add each image file as -f <path.img>:
+
+    ./rodiscd -f myimage.iso -f myimage2.iso
+
+Security
+--------
+
+Potentially a security nightmare -- open web server to everyone.
-- 
cgit v1.2.3