diff --git a/README-ja.md b/README-ja.md index 45953ed..4f36c05 100644 --- a/README-ja.md +++ b/README-ja.md @@ -31,6 +31,7 @@ - [デフォルトOPTIONSハンドラー](#デフォルトoptionsハンドラー) - [ベンチマークテスト](#ベンチマークテスト) - [設計](#設計) +- [Wiki](#wiki) - [コントリビューション](#コントリビューション) - [スポンサー](#スポンサー) - [ライセンス](#ライセンス) @@ -64,7 +65,7 @@ go get -u github.com/bmf-san/goblin # 例 サンプルの実装を用意しています。 -[_examples](https://github.com/bmf-san/goblin/blob/master/_examples)をご参照ください。 +[example_goblin_test.go](https://github.com/bmf-san/goblin/blob/master/example_goblin_test.go)をご参照ください。 # 使い方 ## メソッドベースのルーティング @@ -335,6 +336,9 @@ HTTPメソッドごとに木を構築するようになっています。 改善のアイデアがあればぜひ教えてください! +# Wiki +参考資料の一覧は[wiki](https://github.com/bmf-san/goblin/wiki)に記載しています。 + # コントリビューション IssueやPull Requestはいつでもお待ちしています。 diff --git a/README.md b/README.md index 5456f79..20f1d38 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ This logo was created by [gopherize.me](https://gopherize.me/gopher/d654ddf2b81c - [Default OPTIONS handler](#default-options-handler) - [Benchmark tests](#benchmark-tests) - [Design](#design) +- [Wiki](#wiki) - [Contribution](#contribution) - [Sponsor](#sponsor) - [Stargazers](#stargazers) @@ -66,7 +67,7 @@ go get -u github.com/bmf-san/goblin # Example A sample implementation is available. -Please refer to [_examples](https://github.com/bmf-san/goblin/blob/master/_examples). +Please refer to [example_goblin_test.go](https://github.com/bmf-san/goblin/blob/master/example_goblin_test.go). # Usage ## Method based routing diff --git a/_examples/main.go b/example_goblin_test.go similarity index 88% rename from _examples/main.go rename to example_goblin_test.go index 112c823..5fdf9a6 100644 --- a/_examples/main.go +++ b/example_goblin_test.go @@ -1,9 +1,10 @@ -package main +package goblin_test import ( + "log" "net/http" - goblin "github.com/bmf-san/goblin" + "github.com/bmf-san/goblin" ) func CORS(next http.Handler) http.Handler { @@ -34,7 +35,7 @@ func BazHandler() http.Handler { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {}) } -func main() { +func ExampleListenAndServe() { r := goblin.NewRouter() r.Methods(http.MethodGet).Handler(`/`, RootHandler()) @@ -44,5 +45,7 @@ func main() { r.Methods(http.MethodPost).Use(CORS).Handler(`/foo/:name`, FooNameHandler()) r.Methods(http.MethodGet).Handler(`/baz`, BazHandler()) - http.ListenAndServe(":9999", r) + if err := http.ListenAndServe(":9999", r); err != nil { + log.Fatal(err) + } }