From 965dd5f08d6ac9f33b8b3e9403bf67caef1f1496 Mon Sep 17 00:00:00 2001 From: Camel Aissani Date: Sat, 23 Jul 2016 10:57:41 +0200 Subject: [PATCH] fixed some markdown --- README.md | 40 ++++++++++++++++++++++------------------ docs/application.md | 7 +++---- 2 files changed, 25 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 7b5fe19..a740843 100644 --- a/README.md +++ b/README.md @@ -192,24 +192,24 @@ The app will now be able to react on requests (/birds) and (/birds/about) ||[route(uri)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationrouteuri)|Gets a Router initialized with a root path| ||[use(uri, middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationuseuri-middleware)|Sets a middleware| |||| -||get(uri, middleware)|Applies a middleware on given path for a GET request| -||post(uri, middleware)|Applies a middleware on given path for a POST request| -||put(uri, middleware)|Applies a middleware on given path for a PUT request| -||delete(uri, middleware)|Applies a middleware on given path for a DELETE request| +||[get(uri, middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationgeturi-middleware-applicationposturi-middleware)|Applies a middleware on given path for a GET request| +||[post(uri, middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationgeturi-middleware-applicationposturi-middleware)|Applies a middleware on given path for a POST request| +||[put(uri, middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationgeturi-middleware-applicationposturi-middleware)|Applies a middleware on given path for a PUT request| +||[delete(uri, middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationgeturi-middleware-applicationposturi-middleware)|Applies a middleware on given path for a DELETE request| |||| -||httpGet(request, success, failure)|Invokes a GET ajax request| -||httpPost(request, success, failure)|Invokes a POST ajax request| -||httpPut(request, success, failure)|Invokes a PUT ajax request| -||httpDelete(request, success, failure)|Invokes a DELETE ajax request| +||[httpGet(request, success, failure)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationhttpgetrequest-success-failure-applicationhttppostrequest-success-failure)|Invokes a GET ajax request| +||[httpPost(request, success, failure)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationhttpgetrequest-success-failure-applicationhttppostrequest-success-failure)|Invokes a POST ajax request| +||[httpPut(request, success, failure)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationhttpgetrequest-success-failure-applicationhttppostrequest-success-failure)|Invokes a PUT ajax request| +||[httpDelete(request, success, failure)](https://github.com/camelaissani/frontexpress/blob/master/docs/application.md#applicationhttpgetrequest-success-failure-applicationhttppostrequest-success-failure)|Invokes a DELETE ajax request| |||| |Router ||| ||[use(middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/router.md#routerusemiddleware)|Sets a middleware| ||[all(middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/router.md#routerallmiddleware)|Sets a middleware on all HTTP method requests| |||| -||get(uri, middleware)|Applies a middleware on given path for a GET request| -||post(uri, middleware)|Applies a middleware on given path for a POST request| -||put(uri, middleware)|Applies a middleware on given path for a PUT request| -||delete(uri, middleware)|Applies a middleware on given path for a DELETE request| +||[get(uri, middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/router.md#routergeturi-middleware-routerposturi-middleware)|Applies a middleware on given path for a GET request| +||[post(uri, middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/router.md#routergeturi-middleware-routerposturi-middleware)|Applies a middleware on given path for a POST request| +||[put(uri, middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/router.md#routergeturi-middleware-routerposturi-middleware)|Applies a middleware on given path for a PUT request| +||[delete(uri, middleware)](https://github.com/camelaissani/frontexpress/blob/master/docs/router.md#routergeturi-middleware-routerposturi-middleware)|Applies a middleware on given path for a DELETE request| |||| |Middleware ||| ||[entered(request)](https://github.com/camelaissani/frontexpress/blob/master/docs/middleware.md#middlewareenteredrequest)|Invoked by the app before an ajax request is sent| @@ -217,12 +217,16 @@ The app will now be able to react on requests (/birds) and (/birds/about) ||[updated(request, response)](https://github.com/camelaissani/frontexpress/blob/master/docs/middleware.md#middlewareupdatedrequest-response)|Invoked by the app after an ajax request has responded| ||[failed(request, response)](https://github.com/camelaissani/frontexpress/blob/master/docs/middleware.md#middlewarefailedrequest-response)|Invoked by the app after an ajax request has failed| ||[next()](https://github.com/camelaissani/frontexpress/blob/master/docs/middleware.md#middlewarenext)|Allows to break the middleware chain execution| -|||| -|middleware function ||| -|||| -|request object ||| -|||| -|response object ||| + + +### middleware function + + +### request object + + +### response object + ## License diff --git a/docs/application.md b/docs/application.md index 38cea91..0b429a8 100644 --- a/docs/application.md +++ b/docs/application.md @@ -126,9 +126,8 @@ Samples above can be applied on other HTTP methods. **Parameters** - **request**: `String | Object` uri or object containing uri, http headers, data, history + **request**: `String | Object` uri or object containing uri, http headers, data, history - **success**: `Function` success callback - - **failure**: `Function` failure callback + **success**: `Function` success callback + **failure**: `Function` failure callback