From dfd1af65f8f08a2dd4a6aa16c1c4c4481071bc0c Mon Sep 17 00:00:00 2001
From: Marcel Pociot <m.pociot@gmail.com>
Date: Tue, 10 May 2016 23:55:49 +0200
Subject: [PATCH] Updated README

---
 README.md | 68 ++++++++-----------------------------------------------
 1 file changed, 10 insertions(+), 58 deletions(-)

diff --git a/README.md b/README.md
index 0f307fa..5bfbec6 100644
--- a/README.md
+++ b/README.md
@@ -2,72 +2,24 @@
 #### Simply write beautiful API documentation.
 ========
 
-This project started as a fork of the popular [Slate](https://github.com/tripit/slate) API documentation tool, which uses ruby. Since I found the initial setup of Slate quite cumbersome, I started this NodeJS based project.
+This project is a PHP port of the popular [Slate](https://github.com/tripit/slate) API documentation tool.
 
-<a href="http://www.marcelpociot.com/whiteboard/"><img src="http://www.marcelpociot.com/git/whiteboard_responsive.jpg" style="width: 100%" alt="Whiteboard" /></a>
+> If PHP is not your thing and you're more into nodeJS, why not give [Whiteboard](https://github.com/mpociot/whiteboard) a try?
 
-Check out a Whiteboard [example API documentation](http://www.marcelpociot.com/whiteboard/).
+<a href="http://www.marcelpociot.com/whiteboard/"><img src="http://www.marcelpociot.com/git/whiteboard_responsive.jpg" style="width: 100%" alt="Documentarian" /></a>
 
-## Getting Started with Whiteboard
+Check out a Documentarian [example API documentation](http://www.marcelpociot.com/whiteboard/).
 
-### Prerequisites
+The documentation is available at [http://marcelpociot.com/documentarian/installation](http://marcelpociot.com/documentarian/installation)
 
-You're going to need:
 
- - **[Node JS](https://nodejs.org/en/)**
-
-_Yes, that's it!_
-
-### Getting Set Up
-
- 1. Clone this repository to your hard drive with `git clone https://github.com/mpociot/whiteboard.git`
- 2. `cd whiteboard`
- 3. Install the dependencies: `npm install`
- 4. Start the test server: `npm start`
-
-Now go ahead and visit <http://localhost:4000> and you will be presented with a beautiful example API documentation as a starting point.
-
-Go ahead and modify the markdown file at `source/index.md` to suit your needs.
-
-### Publishing your API documentation
-
-The easiest way to publish your API documentation is using this command within your `whiteboard` directory:
-
-`npm run-script generate`
-
-This will generate a `public` folder which you can upload anywhere you want.
-
-> **Windows users:** You need to install the global `hexo-cli` package using `npm install -g hexo-cli`. To publish your API documentation under windows use `hexo generate`.
-
-If you want other (more automated) deployment options like **git**, **heroku**, **rsync** or **ftp** - please take a look at the [Hexo deployment documentation](https://hexo.io/docs/deployment.html).
-
-### Generate the documentation programmatically
-
-To generate the API documentation programmatically, for example in your automated build process, use the whiteboard module.
-The `generate` method will return a promise.
-
-```js
-var Whiteboard = require('whiteboard');
-Whiteboard.generate()
-  .then(function(){
-    // Generation was successful
-  })
-  .catch(function(){
-    // Handle error
-  })
-```
-
-### Slate compatibility
-Since both Whiteboard and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please [submit an issue](https://github.com/mpociot/whiteboard/issues).
+### Slate / Whiteboard compatibility
+Since both Documentarian and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please [submit an issue](https://github.com/mpociot/documentarian/issues).
 
 ### In depth documentation
-For further documentation, read the [Slate Wiki](https://github.com/tripit/slate/wiki) or the [hexo documentation](https://hexo.io/docs/).
-
-### Documentations built with Whiteboard
+For further documentation, read the [Slate Wiki](https://github.com/tripit/slate/wiki).
 
-* [DISTRIBUTOR API Documentation](https://wifidistribution.com/docs) from [wifidistribution.com](https://wifidistribution.com) 
-* [CommoPrices API Documentation](https://api.commoprices.com/docs/) from [commoprices.com](https://commoprices.com/) 
-* [TradeIt JSON API](https://www.trade.it/documentation/api) from [trade.it](https://www.trade.it/) 
+### Documentations built with Documentarian
 
 Feel free to submit a PR with a link to your documentation.
 
@@ -75,4 +27,4 @@ Feel free to submit a PR with a link to your documentation.
 
 Slate was built by [Robert Lord](https://lord.io) while at [TripIt](http://tripit.com).
 
-Whiteboard was built by Marcel Pociot.
\ No newline at end of file
+Documentarian was built by Marcel Pociot.
\ No newline at end of file