From 606c85805133256eb0d228ae73a8232f532c59b3 Mon Sep 17 00:00:00 2001 From: Nishant Arora Date: Fri, 13 Jan 2017 09:40:23 +0530 Subject: [PATCH] Updated README with screenshots --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4d849ba..659ff01 100755 --- a/README.md +++ b/README.md @@ -1,10 +1,23 @@ - + +## What is a wiki? +A website or database developed collaboratively by a community of users, allowing any user to add and edit content. Example: Wikipedia + +## Why do you need a wiki? +As your company grows it becomes difficult to keep track of all the knowledge in your team. It is difficult to communicate every detail about company policies to new team members. Things get lost in Slack channels. It becomes difficult to keep things in context. + +A wiki helps you keep track of all this information. Every article is filed under a topic to keep things organised among departments. Everything is transparent, who made what changes to which document and when. + +## Why Matterwiki? +Wiki softwares are too complicated for small teams. Matterwiki is just that, a simple wiki for teams to store and collaborate on knowledge. People use it to store documentation, notes, culture guidelines, employee onboarding content and everything else they want to. + ## Setup Instructions: +You need to have `Node` and `npm` installed on your system. + 1. Clone this repository `git clone http://github.com/matterwiki/matterwiki` 2. Run `npm install` 3. Edit `config.js` (present in the project root) and change the `auth_secret` value with any secret phrase. @@ -38,4 +51,15 @@ Raise an issue! We welcome all kinds of contributions. It doesn't matter if it's a grammar fix, or some refactoring, or an even an entire UI overhaul. So help us improve Matterwiki for everyone. +### Screenshots + + +
+ +
+ +
+ +
+