diff --git a/iris/README.md b/iris/README.md index c8fb214e..a23e1331 100644 --- a/iris/README.md +++ b/iris/README.md @@ -4,7 +4,7 @@ This package is the command line tool for [../](https://github.com/kataras/iris ## Install -Current version: 0.0.1 +Current version: 0.0.2 ```sh go get -u github.com/kataras/iris/iris @@ -26,17 +26,33 @@ $ iris [command] [-flags] **The create command** creates for you a start project in a directory + +```sh +iris create -t basic -d ./ +``` + +Will create the [basic](https://github.com/iris-contrib/iris-command-assets/tree/master/basic) sample package to the current working directory and run the app. + +```sh +iris create -t static -d ./ +``` + +Will create the [static](https://github.com/iris-contrib/iris-command-assets/tree/master/static) sample package to the current working directory and run the app. + + +The default + ```sh iris create ``` -Will create the starter/basic project structure to the current working directory and run the app. +Will create the basic sample package to the current working directory and run the app. ```sh iris create -d C:\Users\kataras\Desktop\test1 ``` -Will create the starter/basic project structure to the C:\Users\kataras\Desktop\test1 folder and run the app. +Will create the basic sample package to the C:\Users\kataras\Desktop\test1 folder and run the app. ## Version @@ -49,4 +65,4 @@ Will print the current iris' installed version to your machine ## TODO -A lot more +- [ ] Add more templates diff --git a/iris/main.go b/iris/main.go index 8a160472..03660ec7 100644 --- a/iris/main.go +++ b/iris/main.go @@ -31,12 +31,12 @@ var ( ) func init() { - app = cli.NewApp("iris", "Command line tool for Iris web framework", "0.0.1") + app = cli.NewApp("iris", "Command line tool for Iris web framework", "0.0.2") app.Command(cli.Command("version", "\t prints your iris version").Action(func(cli.Flags) error { app.Printf("%s", iris.Version); return nil })) createCmd := cli.Command("create", "create a project to a given directory"). Flag("dir", "./", "-d ./ creates an iris starter kit to the current directory"). - Flag("type", "basic", "creates the project based on the -t package. Available type is only 'basic', currently"). + Flag("type", "basic", "creates the project based on the -t package. Currently, available types are 'basic' & 'static'"). Action(create) app.Command(createCmd)