mirror of
https://github.com/kataras/iris.git
synced 2026-01-09 13:05:56 +00:00
Version 3.0.0-beta cleaned
This commit is contained in:
52
iris/README.md
Normal file
52
iris/README.md
Normal file
@@ -0,0 +1,52 @@
|
||||
## Package information
|
||||
|
||||
This package is the command line tool for [../](https://github.com/kataras/iris).
|
||||
|
||||
|
||||
## Install
|
||||
Current version: 0.0.1
|
||||
```sh
|
||||
|
||||
go get -u github.com/kataras/iris/iris
|
||||
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
```sh
|
||||
$ iris [command] [-flags]
|
||||
```
|
||||
|
||||
> Note that you must have $GOPATH/bin to your $PATH system/environment variable.
|
||||
|
||||
|
||||
## Create
|
||||
|
||||
|
||||
**The create command** creates for you a start project in a directory
|
||||
|
||||
```sh
|
||||
iris create
|
||||
```
|
||||
|
||||
Will create the starter/basic project structure 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.
|
||||
|
||||
|
||||
## Version
|
||||
|
||||
```sh
|
||||
iris version
|
||||
```
|
||||
|
||||
Will print the current iris' installed version to your machine
|
||||
|
||||
## TODO
|
||||
|
||||
A lot more
|
||||
Reference in New Issue
Block a user