Browse Source

Add Travis widget to README

Vojtech Vitek (V-Teq) 3 years ago
parent
commit
86f21d33a1
2 changed files with 22 additions and 29 deletions
  1. 11
    9
      CONTRIBUTING.md
  2. 11
    20
      README.md

+ 11
- 9
CONTRIBUTING.md View File

@@ -1,28 +1,30 @@
1
+# Contributing
2
+
1 3
 ## Prerequisites
2 4
 
3
-1. Installed and working Go environment
5
+1. [Install Go][go-install].
4 6
 2. Download the sources and switch the working directory:
5 7
 
6 8
     ```bash
7
-    go get -d github.com/pressly/chi
9
+    go get -u -d github.com/pressly/chi
8 10
     cd $GOPATH/src/github.com/pressly/chi
9 11
     ```
10 12
 
11
-## Submitting a Pull request
13
+## Submitting a Pull Request
12 14
 
13
-Your typical workflow will be:
15
+A typical workflow is:
14 16
 
15 17
 1. [Fork the repository.][fork] [This tip maybe also helpful.][go-fork-tip]
16 18
 2. [Create a topic branch.][branch]
17 19
 3. Add tests for your change.
18
-4. Run `go test`. If you tests pass, return to the step 3.
20
+4. Run `go test`. If your tests pass, return to the step 3.
19 21
 5. Implement the change and ensure the steps from the previous step pass.
20
-6. Run `gofmt -w .`, to ensure the new code conforms to Go formatting guidline.
21
-7. [Add, commit and push your changes.][git-help] 
22
+6. Run `goimports -w .`, to ensure the new code conforms to Go formatting guideline.
23
+7. [Add, commit and push your changes.][git-help]
22 24
 8. [Submit a pull request.][pull-req]
23 25
 
24
-
25
-[go-fork-tip]: http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html 
26
+[go-install]: https://golang.org/doc/install
27
+[go-fork-tip]: http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html
26 28
 [fork]: https://help.github.com/articles/fork-a-repo
27 29
 [branch]: http://learn.github.com/p/branching.html
28 30
 [git-help]: https://guides.github.com

+ 11
- 20
README.md View File

@@ -1,6 +1,8 @@
1
-chi [![GoDoc](https://godoc.org/github.com/pressly/chi?status.svg)](https://godoc.org/github.com/pressly/chi)
1
+chi
2 2
 ===
3 3
 
4
+[![GoDoc Widget]][GoDoc] [![Travis Widget]][Travis]
5
+
4 6
 `chi` is a small, fast and expressive router / mux for Go HTTP services built with net/context.
5 7
 
6 8
 Chi encourages writing services by composing small handlers and middlewares with many or few routes.
@@ -261,7 +263,7 @@ Other middlewares:
261 263
 * [httpcoala](https://github.com/goware/httpcoala) - request coalescer
262 264
 * [jwtauth](https://github.com/goware/jwtauth) - JWT authenticator
263 265
 
264
-please submit a PR if you'd like to include a link to a chi middleware
266
+please [submit a PR](./CONTRIBUTING.md) if you'd like to include a link to a chi middleware
265 267
 
266 268
 
267 269
 ## Future
@@ -309,26 +311,15 @@ to reusing URLParams from a pool.
309 311
 * Websocket example
310 312
 * Regexp support in router "/:id([0-9]+)" or "#id^[0-9]+$" or ..
311 313
 
314
+We'll be more than happy to see [your contributions](./CONTRIBUTING.md)!
312 315
 
313 316
 ## License
314 317
 
315
-Copyright (c) 2015 Peter Kieltyka - [github.com/pkieltyka](https://github.com/pkieltyka)
316
-
317
-MIT License
318
-
319
-Permission is hereby granted, free of charge, to any person obtaining a copy of
320
-this software and associated documentation files (the "Software"), to deal in
321
-the Software without restriction, including without limitation the rights to
322
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
323
-the Software, and to permit persons to whom the Software is furnished to do so,
324
-subject to the following conditions:
318
+Copyright (c) 2015 [Peter Kieltyka](https://github.com/pkieltyka)
325 319
 
326
-The above copyright notice and this permission notice shall be included in all
327
-copies or substantial portions of the Software.
320
+Licensed under [MIT License](./LICENSE)
328 321
 
329
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
330
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
331
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
332
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
333
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
334
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
322
+[GoDoc]: https://godoc.org/github.com/pressly/chi
323
+[GoDoc Widget]: https://godoc.org/github.com/pressly/chi?status.svg
324
+[Travis]: https://travis-ci.org/pressly/chi
325
+[Travis Widget]: https://travis-ci.org/pressly/chi.svg?branch=master

Loading…
Cancel
Save