X-Git-Url: https://git.cweiske.de/grauphel.git/blobdiff_plain/6d583b12847a04b3d49eb2b10c52028ba19f9e4f..15b372c9ce79ceb2d3c69247622f8c099f4adf7c:/README.rst?ds=inline

diff --git a/README.rst b/README.rst
index 6afa808..5b5d65a 100644
--- a/README.rst
+++ b/README.rst
@@ -3,13 +3,15 @@ grauphel - tomboy REST server
 *****************************
 ownCloud__ application implementing the `Tomboy`__ `REST API`__ for syncing notes.
 
-Work in progress.
+Pretty stable.
 
 __ http://owncloud.org/
 __ https://wiki.gnome.org/Apps/Tomboy
 __ https://wiki.gnome.org/Apps/Tomboy/Synchronization/REST/1.0
 
 
+.. contents::
+
 ======
 Status
 ======
@@ -49,6 +51,10 @@ grauphel 0.2.1 is known to work with:
 * Tomboy 1.15.1, Windows
 * Tomdroid 0.7.5, Android 4.4.1
 
+See the HowTo__ document for client-specific configuration instructions.
+
+__ docs/howto.rst
+
 
 =============
 Functionality
@@ -85,6 +91,15 @@ __ http://pecl.php.net/package/oauth
 Installation
 ============
 
+App store installation
+======================
+Installation via the app store does not work currently, see
+https://github.com/cweiske/grauphel/issues/26
+
+If one day it works, you can use the ownCloud "Apps" app, select
+"Productivity" and install grauphel with a single click.
+
+
 Manual installation
 ===================
 
@@ -93,9 +108,9 @@ Manual installation
 #. Download the latest release from http://cweiske.de/grauphel.htm and extract it.
    For example::
 
-     $ wget http://cweiske.de/download/grauphel/grauphel-0.5.0.tar.bz2
-     $ tar xjvf grauphel-0.5.0.tar.bz2
-     $ rm grauphel-0.5.0.tar.bz2
+     $ wget http://cweiske.de/download/grauphel/grauphel-0.6.0.tar.bz2
+     $ tar xjvf grauphel-0.6.0.tar.bz2
+     $ rm grauphel-0.6.0.tar.bz2
 
    You do have a directory ``/var/www/owncloud/apps/grauphel`` now.
 #. Using your browser, login as administrator into ownCloud and click
@@ -147,3 +162,34 @@ Development hints
   output.
 * ``latest-sync-revision`` sent from Tomboy during PUT sync is already
   incremented by 1.
+
+
+Unit testing
+============
+- `ownCloud unit testing documentation`__
+- `grauphel on Travis CI`__
+
+  .. image:: https://travis-ci.org/cweiske/grauphel.svg
+     :target: https://travis-ci.org/cweiske/grauphel
+
+__ https://doc.owncloud.org/server/8.0/developer_manual/core/unit-testing.html
+__ https://travis-ci.org/cweiske/grauphel
+
+
+Releasing grauphel
+==================
+To release a new version, do the following:
+
+#. Increase version number in ``appinfo/version`` and ``appinfo/info.xml``.
+#. Fill the ``ChangeLog`` file with the changes since the last release,
+   mention the new version number.
+#. Update ``README.rst`` and increase the version number
+#. Create the grauphel release file with::
+
+     $ phing
+
+   The file will be in ``dist/``
+#. Test the release on a server
+#. Tag the release in git
+#. Upload the release to http://cweiske.de/grauphel.htm
+#. Link the new release on https://apps.owncloud.com/content/show.php?content=166654