Implement note search

[grauphel.git] / README.rst

diff --git a/README.rst b/README.rst
index 4832e1bf6b41c5e9c18bebc535438b59278e3bb5..d9ef609481f58c5f71fd44ca71428492330e44e9 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -5,24 +5,32 @@ ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing note
 
 Work in progress.
 
+__ http://owncloud.org/
+__ https://wiki.gnome.org/Apps/Tomboy
+__ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
+
+
 ======
 Status
 ======
+
+What works
+==========
 - Authentication works
 - Note synchronization works
-- Web interface to view notes is missing
-- OAuth token interface is missing
+- OAuth token management interface works
+- Database management interface (reset) works
 
-__ http://owncloud.org/
-__ https://wiki.gnome.org/Apps/Tomboy
-__ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
+What is missing
+===============
+- Web interface to view notes is missing
 
 
 =================
 Supported clients
 =================
 * Conboy__ (Nokia N900 Maemo)
-* Tomboy__ (Linux)
+* Tomboy__ (Linux, Windows)
 * Tomdroid__ (Android)
 
 __ http://conboy.garage.maemo.org/
@@ -30,6 +38,15 @@ __ https://wiki.gnome.org/Apps/Tomboy
 __ https://launchpad.net/tomdroid
 
 
+Known working versions
+======================
+grauphel 0.2.1 is known to work with:
+
+* Tomboy 1.15.2, Linux
+* Tomboy 1.15.1, Windows
+* Tomdroid 0.7.5, Android 4.4.1
+
+
 ============
 Dependencies
 ============
@@ -55,3 +72,14 @@ Home page
 __ http://apps.owncloud.com/content/show.php?action=content&content=166654
 __ http://git.cweiske.de/grauphel.git/
 __ https://github.com/cweiske/grauphel
+
+
+=================
+Development hints
+=================
+* JSON coming from Tomboy: Title is html-escaped already
+  (e.g. ``>`` is ``>``).
+  We store it that way in the database, so there is no need to escape the
+  output.
+* ``latest-sync-revision`` sent from Tomboy during PUT sync is already
+  incremented by 1.