talk about searching

[grauphel.git] / README.rst

diff --git a/README.rst b/README.rst
index 0e3113f3b28c46d6b45f01054aaf7b987ef4541d..8320eca16b6464b6f1991dbd60bdee3ef75836e7 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -20,10 +20,13 @@ What works
 - Note synchronization works
 - OAuth token management interface works
 - Database management interface (reset) works
+- Viewing notes
+- Searching notes
 
 What is missing
 ===============
-- Web interface to view notes is missing
+- Web interface to edit notes. I will probably not implement this.
+  Patches welcome :-)
 
 
 =================
@@ -47,6 +50,28 @@ grauphel 0.2.1 is known to work with:
 * 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
 ============
@@ -72,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.