Skip to content

Commit

Permalink
docs: update read me
Browse files Browse the repository at this point in the history
  • Loading branch information
saucecodee committed Nov 3, 2020
1 parent 67554c7 commit 43eb276
Showing 1 changed file with 13 additions and 14 deletions.
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)
Expand All @@ -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

Expand All @@ -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
Expand Down

0 comments on commit 43eb276

Please sign in to comment.