From 43eb276db4668eb2be25a8733b3906affe944217 Mon Sep 17 00:00:00 2001 From: saucecodee Date: Wed, 4 Nov 2020 00:45:47 +0100 Subject: [PATCH] docs: update read me --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 75dc2ed..2217abc 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,13 @@ [![BangaJS Logo](https://i.ibb.co/qr5jqrk/BangaJS.png)](https://bangajs.netlify.app/) - Banga is a cli generator for building [ExpressJS](https://expressjs.com) applications with speed and efficiency. - - [![NPM Version][npm-image]][npm-url] - [![NPM Downloads][downloads-image]][downloads-url] +BangaJS is a cli generator for building [ExpressJS](https://expressjs.com) applications with speed and efficiency. +[![NPM Version][npm-image]][npm-url] +[![NPM Downloads][downloads-image]][downloads-url] ## Installation -BangaJS is available on the [Node.js](https://nodejs.org/en/) module through the +It's available on the [Node.js](https://nodejs.org/en/) module through the [npm registry](https://www.npmjs.com/). Before installing, [download and install Node.js](https://nodejs.org/en/download/) @@ -21,29 +20,29 @@ $ npm install bangajs -g ## Features - * Quick project setup - * Generate Route, controller and Service files with CRUD methods. +- Quick project setup +- Generate Route, controller and Service files with CRUD methods. ## Docs - * [Website and Documentation](https://bangajs.netlify.app/) +- [Website and Documentation](https://bangajs.netlify.app/) ## Getting started - Now let's create a new Express app named **hello-app**. It would be created in a new folder called **hello-app** in the current working directory: +Now let's create a new Express app **hello-world**. It would be created in a new folder called **hello-world** in the current working directory: ```bash -$ banga new hello-app +$ banga new hello-world ``` - Then navigate into the newly created project and start up the server: +Then navigate into the newly created project and start up the server: ```bash -$ cd hello-app +$ cd hello-world $ npm run dev ``` - By default the server will be running on http://localhost:2020/ +By default the server will be running on http://localhost:2020/ ## People @@ -53,7 +52,7 @@ The author of BangaJS is [Onyegbu Ifedili](https://github.com/saucecodee) ## License - [MIT](LICENSE) +[MIT](LICENSE) [npm-image]: https://img.shields.io/npm/v/bangajs.svg [npm-url]: https://npmjs.com/package/bangajs