diff --git a/README.md b/README.md index 78499a4..63af45d 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/) @@ -20,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 @@ -34,26 +26,7 @@ $ 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: - - Clone the git repository: - -```bash -$ git clone git@github.com:camelaissani/frontexpress-sample.git -$ cd frontexpress-sample -``` - - 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 @@ -71,6 +44,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