From 8e1623863af270b8645a4d1a454e090961b44ad5 Mon Sep 17 00:00:00 2001 From: ICELI Date: Fri, 23 Jun 2017 10:56:17 +0800 Subject: [PATCH] docs: update usage --- Readme.md | 89 +++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 63 insertions(+), 26 deletions(-) diff --git a/Readme.md b/Readme.md index 0962b64..455fe6f 100644 --- a/Readme.md +++ b/Readme.md @@ -1,5 +1,5 @@ # jm-cli -> a CLI tool for jumore FE team +> A CLI tool for jumore FE team. ## Install: @@ -11,7 +11,7 @@ $ npm i -g jm-cli ### from github(latest) ```bash -$ git clone https://github.com/jm-team/jm-cli.git +$ git clone https://github.com/ICELI/jm-cli.git $ cd jm-cli $ npm link ``` @@ -32,10 +32,7 @@ install package ```bash $ jm install -``` -or - -```bash +# or $ jm i ``` @@ -50,22 +47,47 @@ production build ```bash $ jm build ``` -open browser +production server +```bash +$ jm server +# or +$ jm s +# open browser http://localhost:8081 ``` -http://localhost:8081 + +release ng-seed or vue-seed + +```bash +$ jm seed +# same as +$ jm d && jm l && jm a && jm site ``` -new page +gen jsdoc ```bash -$ jm ng:page pageName +$ jm jsdoc # or -$ jm ng:page path/pageName +$ jm d +# need to configure file +``` + +gen CHANGELOG.md +```bash +$ jm changelog +# or +$ jm l +# CHANGELOG.md - default file name + +$ jm log log.md +# log.md - program.args[0] as file name ``` gen AUTHORS.md ```bash $ jm author +# or +$ jm a # AUTHORS.md - default file name $ jm author author.md @@ -80,10 +102,24 @@ author.md - xxxxx - xxxx -#### Generated by build/authors.js. +#### Generated by jm-cli.js. ``` +gen gh-pages +```bash +$ jm site +# push dist/ to github pages +``` + +gen new page for angular project +```bash +$ jm ng:page pageName +# or +$ jm ng:page path/pageName +``` + + ```bash Usage: jm [options] @@ -91,22 +127,23 @@ author.md Commands: - init initialize project, you can choose the framework with AngularJS or Vue2 - install|i Install Package - dev dev build - build production build - seed publish seed - jsdoc generator jsdoc - changelog generator changelog.md - author generator authors.md - site push gh-pages - ng:page generator new page + init initialize project, you can choose the framework with AngularJS or Vue2 + install|i Install Package + dev dev build + build production build + server|s production service + seed publish seed + jsdoc|d generator jsdoc + changelog|l generator CHANGELOG.md + author|a generator AUTHORS.md + site push gh-pages + ng:page generator new page Options: - -h, --help output usage information - -V, --version output the version number - -c, --config [path] config file path + -h, --help output usage information + -V, --version output the version number + -c, --configure config file path ``` @@ -115,7 +152,7 @@ author.md (The MIT License) -Copyright (c) 2016 iceli <woticeli@gmail.com> +Copyright (c) 2016-present iceli <woticeli@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the