make linking of notes with <speci"a'l> chars work
[grauphel.git] / README.rst
1 *****************************
2 grauphel - tomboy REST server
3 *****************************
4 ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
5
6 Work in progress.
7
8 __ http://owncloud.org/
9 __ https://wiki.gnome.org/Apps/Tomboy
10 __ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
11
12
13 ======
14 Status
15 ======
16
17 What works
18 ==========
19 - Authentication works
20 - Note synchronization works
21 - OAuth token management interface works
22 - Database management interface (reset) works
23
24 What is missing
25 ===============
26 - Web interface to view notes is missing
27
28
29 =================
30 Supported clients
31 =================
32 * Conboy__ (Nokia N900 Maemo)
33 * Tomboy__ (Linux, Windows)
34 * Tomdroid__ (Android)
35
36 __ http://conboy.garage.maemo.org/
37 __ https://wiki.gnome.org/Apps/Tomboy
38 __ https://launchpad.net/tomdroid
39
40
41 Known working versions
42 ======================
43 grauphel 0.2.1 is known to work with:
44
45 * Tomboy 1.15.2, Linux
46 * Tomboy 1.15.1, Windows
47 * Tomdroid 0.7.5, Android 4.4.1
48
49
50 ============
51 Dependencies
52 ============
53 * PHP
54 * PHP `oauth extension`__
55
56 __ http://pecl.php.net/package/oauth
57
58
59 ======
60 Author
61 ======
62 Christian Weiske, cweiske@cweiske.de, http://cweiske.de/
63
64
65 =========
66 Home page
67 =========
68 - `grauphel on apps.owncloud.com`__
69 - `Source code repository`__
70 - `Github source code mirror`__
71
72 __ http://apps.owncloud.com/content/show.php?action=content&content=166654
73 __ http://git.cweiske.de/grauphel.git/
74 __ https://github.com/cweiske/grauphel
75
76
77 =================
78 Development hints
79 =================
80 * JSON coming from Tomboy: Title is html-escaped already
81   (e.g. ``>`` is ``&gt;``).
82   We store it that way in the database, so there is no need to escape the
83   output.
84 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
85   incremented by 1.