-
Notifications
You must be signed in to change notification settings - Fork 8.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improvements and more begginer-friendly README #1709
Conversation
I have updated the file to make it easier for beginners to get started, and also fixed some weird things.
@@ -81,14 +83,13 @@ $ go get -u github.com/gin-gonic/gin | |||
```go | |||
import "github.com/gin-gonic/gin" | |||
``` | |||
|
|||
3. (Optional) Import `net/http`. This is required for example if using constants such as `http.StatusOK`. | |||
3. (Optional) Import `net/http`. This is required if you want to use constants such as `http.StatusOK`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add an empty line before "```".
@@ -2035,8 +2042,7 @@ func TestPingRoute(t *testing.T) { | |||
``` | |||
|
|||
## Users | |||
|
|||
Awesome project lists using [Gin](https://github.com/gin-gonic/gin) web framework. | |||
List of awesome projects made with the [Gin](https://github.com/gin-gonic/gin) web framework. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add an empty line after ## Users
and please also check errors from Travis |
Codecov Report
@@ Coverage Diff @@
## master #1709 +/- ##
==========================================
+ Coverage 99.4% 99.42% +0.01%
==========================================
Files 42 42
Lines 2029 2073 +44
==========================================
+ Hits 2017 2061 +44
Misses 9 9
Partials 3 3
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@samueldcs please fix comment and I will merge it, thanks!
@samueldcs thanks! closing, please see #1793 |
I have updated the file to make it easier for beginners to get started, and also fixed some weird things.