summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYehonal <yehonal.azeroth@gmail.com>2018-12-19 23:50:36 +0100
committerGitHub <noreply@github.com>2018-12-19 23:50:36 +0100
commit2c1f02fe3eb036b2b827c7937a2d887e63c13af0 (patch)
tree5b87285051d41a317bbebd45e84751b8f441f9fd
parent533880099c099fea7054d31b288371903f7bf2aa (diff)
downloadwiki-2c1f02fe3eb036b2b827c7937a2d887e63c13af0.tar.gz
wiki-2c1f02fe3eb036b2b827c7937a2d887e63c13af0.tar.bz2
wiki-2c1f02fe3eb036b2b827c7937a2d887e63c13af0.zip
Update README.md
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8174351..273e1fb 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,20 @@
# git-wiki
-A github pages / jekyll powered wiki. Readme and demo: (http://drassil.github.io/git-wiki)
+it's a **modular and full featured wiki** powered by git, github pages and pull-requests!
+
+It means:
+
+* Improvements in the **cooperative** aspect: forks, pull-requests and roles.
+* You can **customize your wiki** as you want with style sheets and even changing the layout. (see customization section below)
+* **No databases!** Only static files that can be downloaded in a few seconds.
+* **Blazing fast** and free thankfully to Github Pages and Jekyll Server Side Generation process!
+* **Markdown and html** mixed together!
+* **History, revision comparison** and everything you need from a wiki platform.
+* You can **edit your pages** with the standard git editor, prose.io (integrated) or any kind of editor you prefer.
+* Non-existent wiki page links are "[red](wiki/red.md)"
+* **Component system with hooks** that allows you to totally customize your wiki UI. (see customization section below)
+* Some **nice internal themes** to change your entire wiki UI with 1 simple configuration (see customization section below)
+* Integrated **Blogging** feature thanks to jekyll!
+
+
+Readme and demo: (http://drassil.github.io/git-wiki)