Skip to content

Commit 756e088

Browse files
authored
Merge pull request #116 from hbrylkowski/master
Add more details in readme
2 parents 1098d0e + c7e5b8a commit 756e088

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,28 @@ Then verify that `gin` was installed correctly:
2424
```shell
2525
gin -h
2626
```
27+
## Basic usage
28+
```shell
29+
gin run main.go
30+
```
31+
Options
32+
```
33+
--laddr value, -l value listening address for the proxy server
34+
--port value, -p value port for the proxy server (default: 3000)
35+
--appPort value, -a value port for the Go web server (default: 3001)
36+
--bin value, -b value name of generated binary file (default: "gin-bin")
37+
--path value, -t value Path to watch files from (default: ".")
38+
--build value, -d value Path to build files from (defaults to same value as --path)
39+
--excludeDir value, -x value Relative directories to exclude
40+
--immediate, -i run the server immediately after it's built
41+
--all reloads whenever any file changes, as opposed to reloading only on .go file change
42+
--godep, -g use godep when building
43+
--buildArgs value Additional go build arguments
44+
--certFile value TLS Certificate
45+
--keyFile value TLS Certificate Key
46+
--help, -h show help
47+
--version, -v print the version
48+
```
2749

2850
## Supporting Gin in Your Web app
2951
`gin` assumes that your web app binds itself to the `PORT` environment

0 commit comments

Comments
 (0)