update changelog; prepare 0.4.0
[grauphel.git] / README.rst
index 886a3e2..8320eca 100644 (file)
@@ -5,17 +5,28 @@ 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
+- Viewing notes
+- Searching notes
 
-__ 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 edit notes. I will probably not implement this.
+  Patches welcome :-)
 
 
 =================
@@ -30,6 +41,37 @@ __ 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
+
+
+=============
+Functionality
+=============
+
+Search
+======
+You can use ownCloud's global search on the top right.
+
+During search, the note's titles, tags and content are searched.
+
+Search syntax:
+
+``foo``
+  Search for notes containing "foo"
+``foo bar``
+  Search for notes containing "foo" and "bar"
+``"foo bar" baz``
+  Search for notes containing "foo bar" and "baz"
+``foo -bar``
+  Search for notes containing "foo" but not "bar"
+
+
 ============
 Dependencies
 ============
@@ -55,3 +97,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.