Skip to content

Commit d41e6ab

Browse files
authored
Merge pull request #9 from kiyonlin/master
Improve README and bump version 0.0.1
2 parents 9952d39 + 0bafa23 commit d41e6ab

File tree

2 files changed

+82
-2
lines changed

2 files changed

+82
-2
lines changed

README.md

Lines changed: 80 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,85 @@
11
# fiber-cli
22
Fiber Command Line Interface
33

4-
# installation
4+
# Installation
55
```bash
6-
go get github.com/gofiber/fiber-cli/fiber
6+
go get -u github.com/gofiber/fiber-cli/fiber
7+
```
8+
9+
# Commands
10+
## fiber
11+
### Synopsis
12+
13+
🚀 Fiber is an Express inspired web framework written in Go with 💖
14+
Learn more on https://gofiber.io
15+
16+
### Options
17+
18+
```
19+
-h, --help help for fiber
20+
```
21+
22+
## fiber version
23+
### Synopsis
24+
25+
Print the local and released version number of fiber
26+
27+
```
28+
fiber version [flags]
29+
```
30+
31+
### Options
32+
33+
```
34+
-h, --help help for version
35+
```
36+
37+
## fiber new
38+
### Synopsis
39+
40+
Generate a new fiber project
41+
42+
```
43+
fiber new PROJECT [module name] [flags]
44+
```
45+
46+
### Examples
47+
48+
```
49+
fiber new fiber-demo
50+
Generates a project with go module name fiber-demo
51+
52+
fiber new fiber-demo your.own/module/name
53+
Specific the go module name
54+
55+
fiber new fiber-demo -t=complex
56+
Generate a complex project
57+
```
58+
59+
### Options
60+
61+
```
62+
-h, --help help for new
63+
-t, --template string basic|complex (default "basic")
64+
```
65+
66+
## fiber dev
67+
### Synopsis
68+
69+
Rerun the fiber project if watched files changed
70+
71+
```
72+
fiber dev [flags]
73+
```
74+
75+
### Options
76+
77+
```
78+
-d, --delay duration delay to trigger rerun (default 1s)
79+
-D, --exclude_dirs strings ignore these directories (default [assets,tmp,vendor,node_modules])
80+
-F, --exclude_files strings ignore these files
81+
-e, --extensions strings file extensions to watch (default [go,tmpl,tpl,html])
82+
-h, --help help for dev
83+
-r, --root string root path for watch, all files must be under root (default ".")
84+
-t, --target string target path for go build (default ".")
785
```

fiber/main.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@ package main
22

33
import "github.com/gofiber/fiber-cli/cmd"
44

5+
const version = "0.0.1"
6+
57
func main() {
68
cmd.Execute()
79
}

0 commit comments

Comments
 (0)