readme

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..daa30a3
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+README.html

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..13f0353
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,45 @@
+*****************************
+grauphel - tomboy REST server
+*****************************
+ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
+
+Work in progress.
+
+======
+Status
+======
+- Authentication works
+- Note synchronization works
+- Web interface to view notes is missing
+- OAuth token interface is missing
+
+__ http://owncloud.org/
+__ https://wiki.gnome.org/Apps/Tomboy
+__ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
+
+
+=================
+Supported clients
+=================
+* Conboy__
+* Tomboy__
+
+__ http://conboy.garage.maemo.org/
+__ https://wiki.gnome.org/Apps/Tomboy
+
+Tomdroid does not work yet.
+
+
+============
+Dependencies
+============
+* PHP
+* PHP `oauth extension`__
+
+__ http://pecl.php.net/package/oauth
+
+
+======
+Author
+======
+Christian Weiske, cweiske@cweiske.de, http://cweiske.de/