flynx/pWiki
1
1
Fork 0
mirror of https://github.com/flynx/pWiki.git synced 2025-10-31 11:00:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated readme...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2016-08-15 19:01:47 +03:00
parent 39234e6e4a
commit 21f864f1fe
1 changed files with 15 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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