From 21f864f1fed5347e2e5050f2796f21d9613b8886 Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Mon, 15 Aug 2016 19:01:47 +0300 Subject: [PATCH] updated readme... Signed-off-by: Alex A. Naanou --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a94bcd1..2351905 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,29 @@ # Portable Wiki (pWiki) ### Project goals / main features: + - _Simple embeddable Wiki_ - This enables a zero-workflow app documentation, i.e. documentation that - can be created, edited, tweaked and updated in-app without requiring - setting up and maintaining a write-convert-embed workflow. + To be used as a zero-workflow app documentation platform, i.e. + documentation that can be created, edited, tweaked and updated in-app + without requiring setting up and maintaining a write-convert-embed + workflow. - This was a requirement on the _ImageGrid.Viewer_ project. + This was a requirement on the _ImageGrid.Viewer_ project and as a + side-effect pWiki hosts it's own documentation too. - _Pluggable storage and synchronization_ mechanisms + A set of tools and API's to enable data synchronization between pWiki + instances. + - _Self-hosted_ and flexible user interface + The pWiki interface is implemented as a set of pWiki pages and + templates within pWiki itself (see: /bootstrap), this enables the user + to customize the look feel and to some extent the function of the + interface from within pWiki, without touching the code. + - Wiki/note _portable app_ - a simple and functional note/todo/outline app