diff --git a/README.md b/README.md index 85b24f3..1f4c838 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,28 @@ -Launch the server and punch this in your browser: +# Ubuntu One SyncDaemon REST API Server -http://localhost:3000/status/current_downloads +## What's it do? + +Creates a RESTful interface to Ubuntu One's DBus interface that lives on port 3000 and can be utlized to build client side web applications on top of Ubuntu One. + +## Why does this exist? + +This little server is the result of fighting with the PHP DBus bindings and trying it to work in the local user space. + +## How do I run it? + +Assuming you already have Node.js on your system and are running Ubuntu (Only OS I'll be testing this one) then all you need to do is run: + + node ubuntuone.js + +## How do I talk to it? + +Communicating with the server can be done by pointing your web browser to http://localhost:3000/status/current_status + +The format of the URI is /objectPath/method + +## What's the future hold? + +* Documentation page when calling the server with no path +* Support for the root object path's methods (connect, disconnect, et cetera) +* POST methods to push as well as pull data +* Potentially spinning off this server into a more generic DBus web interface