From 796fbf5eb16717bfd26d4db163f0b537d2914ccf Mon Sep 17 00:00:00 2001 From: Camel Aissani Date: Sat, 9 Jul 2016 03:30:21 +0200 Subject: [PATCH 1/3] Update README.md --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e869820..f1c72e3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,3 @@ -> -> -> ## Caution README in progress -> -> - # frontexpress Minimalist front end router framework a la [express](http://expressjs.com/) @@ -34,13 +28,13 @@ $ npm install frontexpress ## Quick Start - The quickest way to get started with frontexpress is to clone [frontexpress sample](https://github.com/camelaissani/frontexpress) to generate an application as shown below: + The quickest way to get started with frontexpress is to clone [frontexpress-demo](https://github.com/camelaissani/frontexpress-demo) to generate an application as shown below: Clone the git repository: ```bash -$ git clone git@github.com:camelaissani/frontexpress-sample.git -$ cd frontexpress-sample +$ git clone git@github.com:camelaissani/frontexpress-demo.git +$ cd frontexpress-demo ``` Install dependencies: @@ -71,6 +65,17 @@ $ npm install $ npm test ``` +## Disclaimer + +> +> In this first version of frontexpress, the API is not completely the miror of the expressjs one. +> +> There are some missing methods. Currently, the use, get, post... methods having a middlewares array as parameter are not available. +> The string pattern to define route paths is not yet implemented. +> +> Obviously, the objective is to have the same API as expressjs when the methods make sense browser side. +> + ## Routing ### Basic routing From 96eb11803374ae379d801e98b82b70e9a61ae3e9 Mon Sep 17 00:00:00 2001 From: Camel Aissani Date: Sat, 9 Jul 2016 04:05:29 +0200 Subject: [PATCH 2/3] Update README.md --- README.md | 21 +-------------------- 1 file changed, 1 insertion(+), 20 deletions(-) diff --git a/README.md b/README.md index f1c72e3..d0d6207 100644 --- a/README.md +++ b/README.md @@ -28,26 +28,7 @@ $ npm install frontexpress ## Quick Start - The quickest way to get started with frontexpress is to clone [frontexpress-demo](https://github.com/camelaissani/frontexpress-demo) to generate an application as shown below: - - Clone the git repository: - -```bash -$ git clone git@github.com:camelaissani/frontexpress-demo.git -$ cd frontexpress-demo -``` - - Install dependencies: - -```bash -$ npm install -``` - - Start the server: - -```bash -$ npm start -``` + The quickest way to get started with frontexpress is to clone [frontexpress-demo](https://github.com/camelaissani/frontexpress-demo) ## Tests From 5a65221427dd908f8fd3664a9621c90542230cd8 Mon Sep 17 00:00:00 2001 From: Camel Aissani Date: Sat, 9 Jul 2016 04:09:33 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d0d6207..d855391 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,8 @@ app.get('/', (req, res) => { window.alert('Hello World'); }); -// Once DOM is loaded start listening HTTP requests -document.addEventListener("DOMContentLoaded", (event) => { - app.listen(); -}); +// start listening frontend application requests +app.listen(); ``` ## Installation