From 3c5a87eac8dd97b7b2b938aa01631bf7953788c9 Mon Sep 17 00:00:00 2001 From: Dmitriy Pleshevskiy Date: Mon, 11 Jun 2018 08:44:39 +0300 Subject: [PATCH] Update readme --- README.md | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 01a3f4d..7c69e85 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ This script allows a create new project using a ready-made templates. +You can use template on local machine or repositories. + +By default it looks for a name of template in the +[official repository](https://github.com/ictmpl) + # Installing @@ -14,11 +19,23 @@ or globally: # Usage - ictmpl create +## create + +Create new project by template + +`ictmpl create ` + +#### Params: + +**project_path** - Path to new project directory + +**template_name** - Name of template / link to git repository / local path - ictmpl create flaskproject flask-blank +#### Examples: + +`ictmpl create flaskproject flask-blank` - ictmpl create myproject ../my-local-template/ +`ictmpl create myproject ../my-local-template/` - ictmpl create /var/www/myproject https://github.com/ictmpl/flask-blank.git +`ictmpl create /var/www/myproject https://github.com/ictmpl/flask-blank.git`