Skip to content

Commit 4a0a026

Browse files
committed
update version and docs
1 parent 93d6061 commit 4a0a026

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

README.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# mern-cli
2-
[![Build Status](https://travis-ci.org/Hashnode/mern-cli.svg?branch=v2.0.0)](https://travis-ci.org/Hashnode/mern-cli)
2+
[![Build Status](https://travis-ci.org/Hashnode/mern-cli.svg?branch=v3.0.0)](https://travis-ci.org/Hashnode/mern-cli)
33
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
44

55
A CLI for getting started with MERN stack. It offers a [super simple boilerplate project](https://github.com/Hashnode/mern-starter) and additional utilities to get started with isomorphic React and Redux apps.
@@ -8,10 +8,17 @@ A CLI for getting started with MERN stack. It offers a [super simple boilerplate
88
npm install -g mern-cli
99
```
1010

11+
Available Commands
12+
```
13+
init [name] -t=<variant_name> Initialize a MERN project (Default variant: mern-starter).
14+
list List MERN variants
15+
search [term] Search for a MERN variant
16+
info [term] View details of a MERN variant
17+
```
1118

12-
Create a new app
19+
Create a new app with default `mern-starter`
1320
```
14-
mern my_app
21+
mern init my_app
1522
```
1623

1724
Install Dependencies
@@ -23,13 +30,16 @@ cd my_app && npm install
2330

2431
Generate React components, Express routes and controllers and Mongoose models using mern generator.
2532

26-
Docs Coming Soon
33+
To list out all available generators
34+
```
35+
merng
36+
```
2737

2838
## Help and Version
2939

3040
```
3141
mern -v // Check CLI version
32-
merng --help // Get help and check usage
42+
mern --help // Get help and check usage
3343
```
3444

3545
## Roadmap

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mern-cli",
3-
"version": "2.0.0",
3+
"version": "3.0.0",
44
"description": "A cli for generating MERN boilerplate",
55
"main": "index.js",
66
"watch": {

0 commit comments

Comments
 (0)