From be20f984980b345c9c71d497a2693c8a59a6520e Mon Sep 17 00:00:00 2001
From: Camel Aissani <camel.aissani@nuageprive.fr>
Date: Sat, 23 Jul 2016 00:02:34 +0200
Subject: [PATCH] added docs

---
 docs/application.md  | 77 ++++++++++++++++++++++++++++++++++++++++++++
 docs/frontexpress.md | 22 +++++++++++++
 docs/middleware.md   | 63 ++++++++++++++++++++++++++++++++++++
 docs/router.md       | 39 ++++++++++++++++++++++
 4 files changed, 201 insertions(+)
 create mode 100644 docs/application.md
 create mode 100644 docs/frontexpress.md
 create mode 100644 docs/middleware.md
 create mode 100644 docs/router.md

diff --git a/docs/application.md b/docs/application.md
new file mode 100644
index 0000000..74005bb
--- /dev/null
+++ b/docs/application.md
@@ -0,0 +1,77 @@
+# Application
+
+## Application.set(setting, val) 
+
+Assign `setting` to `val`, or return `setting`'s value.
+
+```js
+   app.set('foo', 'bar');
+   app.set('foo');
+   // => "bar"
+```
+
+**Parameters**
+
+  **setting**: `String`, setting name
+
+  **val**: `*`, setting value
+
+**Returns**: `app`, for chaining
+
+
+## Application.listen(callback) 
+
+Listen to DOM initialization and history state changes.
+
+The callback function is called once the DOM has
+the `document.readyState` equals to 'interactive'.
+
+```js
+   app.listen(()=> {
+       console.log('App is listening requests');
+       console.log('DOM is ready!');
+   });
+```
+
+**Parameters**
+
+  **callback**: `function`, DOM is ready callback
+
+
+## Application.route(uri) 
+
+Returns a new `Router` instance for the _uri_.
+See the Router api docs for details.
+
+```js
+   app.route('/');
+   // =>  new Router instance
+```
+
+**Parameters**
+
+  **uri**: `String`, path
+
+**Returns**: `Router`, for chaining
+
+
+## Application.use(uri, middleware) 
+
+Use the given middleware function or object, with optional _uri_.
+Default _uri_ is "/".
+
+```js
+   // middleware function will be applied on path "/"
+   app.use((req, res, next) => {console.log('Hello')});
+
+   // middleware object will be applied on path "/"
+   app.use(new Middleware());
+```
+
+**Parameters**
+
+   **uri**: `String`, path
+
+   **middleware**: `Middleware | function`, Middleware object or function
+
+**Returns**: `app`, for chaining
diff --git a/docs/frontexpress.md b/docs/frontexpress.md
new file mode 100644
index 0000000..46e574d
--- /dev/null
+++ b/docs/frontexpress.md
@@ -0,0 +1,22 @@
+# Frontexpress
+
+
+## frontexpress() 
+
+Create a frontexpress application.
+
+**Returns**: `Application`, the application
+
+
+## frontexpress.Router 
+
+Expose the Router constructor
+
+**Returns**: `Router`
+
+
+## frontexpress.Middleware() 
+
+Expose the Middleware constructor
+
+**Returns**: `Middleware`
diff --git a/docs/middleware.md b/docs/middleware.md
new file mode 100644
index 0000000..dcded09
--- /dev/null
+++ b/docs/middleware.md
@@ -0,0 +1,63 @@
+# Middleware
+
+## Middleware.entered(request) 
+
+Invoked by the app before ajax request are sent or
+during the DOM loading (document.readyState === 'loading').
+See Application#_callMiddlewareEntered documentation for details.
+
+Override this method to add your custom behaviour
+
+**Parameters**
+
+**request**: `Object`
+
+
+## Middleware.exited(request) 
+
+Invoked by the app before a new ajax request is sent or before the DOM unloading.
+See Application#_callMiddlewareExited documentation for details.
+
+Override this method to add your custom behaviour
+
+**Parameters**
+
+**request**: `Object`
+
+
+## Middleware.updated(request, response) 
+
+Invoked on ajax request responding or on DOM ready
+(document.readyState === 'interactive').
+See Application#_callMiddlewareUpdated documentation for details.
+
+Override this method to add your custom behaviour
+
+**Parameters**
+
+**request**: `Object`
+
+**response**: `Object`
+
+
+## Middleware.failed(request, response) 
+
+Invoked when ajax request fails.
+
+Override this method to add your custom behaviour
+
+**Parameters**
+
+**request**: `Object`
+
+**response**: `Object`
+
+
+## Middleware.next() 
+
+Allow the hand over to the next middleware object or function.
+
+Override this method and return `false` to break execution of
+middleware chain.
+
+**Returns**: `Boolean`, `true` by default
diff --git a/docs/router.md b/docs/router.md
new file mode 100644
index 0000000..4aa7dc6
--- /dev/null
+++ b/docs/router.md
@@ -0,0 +1,39 @@
+# Router
+
+## Router.use(middleware) 
+
+Use the given middleware function or object on this router.
+
+```js
+   // middleware function
+   router.use((req, res, next) => {console.log('Hello')});
+
+   // middleware object
+   router.use(new Middleware());
+```
+
+**Parameters**
+
+**middleware**: `Middleware | function`, Middleware object or function
+
+**Returns**: `Router`, for chaining
+
+
+## Router.all(middleware) 
+
+Use the given middleware function or object on this router for
+all HTTP methods.
+
+```js
+   // middleware function
+   router.all((req, res, next) => {console.log('Hello')});
+
+   // middleware object
+   router.all(new Middleware());
+```
+
+**Parameters**
+
+**middleware**: `Middleware | function`, Middleware object or function
+
+**Returns**: `Router`, for chaining