This repository has been archived by the owner on Jun 18, 2018. It is now read-only.
Add documentation for gokit #10
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
March 17, 2017 18:06
zeeshanabid
force-pushed
the
doc
branch
3 times, most recently
from
8e27409
to
8e652cb
Compare
abhimanyubabbar
suggested changes
Mar 23, 2017
README.md
Outdated
| [here](example/example.go). | ||
|
|
||
| ## Creating a service | ||
| A service is created by calling `SimpleService` function in `kit` package. This creates a service and some default |
There was a problem hiding this comment.
I would use predefined set of middlewares instead of some default middlewares
README.md
Outdated
| ## Context | ||
| Gokit provides some wrapper functions for `context.Context`. These wrappers are used internally for setting data in | ||
| context and passing it around in different modules. It is recommended to use these functions when you want to read | ||
| or set data in context. For details have a look at [wrpctx](wrpctx/wrpctx.go) package. |
README.md
Outdated
| ## Logging | ||
| Gokit provides a custom formatter for [logrus](https://github.com/sirupsen/logrus). This formatter adds some extra | ||
| fields to the log entry. The log entry is then formatted to JSON before it is written to the stdout. It is recommended | ||
| to use this default formatter but you can easily override it if it is necessary. See logrus's documentation to see how |
There was a problem hiding this comment.
if necessary instead of if it is necessary
| @@ -0,0 +1,227 @@ | |||
| # Gokit | |||
There was a problem hiding this comment.
Explicitly say Gokit works with golang 1.8 and above ?
README.md
Outdated
| ### Wrap Context | ||
| `Default: yes` | ||
|
|
||
| Wrapp context is a simple middleware to add some extra functionality around `context.Context`. For example it is not |
There was a problem hiding this comment.
Wrapp context is a middleware used to add extra functionality around ... ?
Remove vague words like some and simple maybe ?
README.md
Outdated
| ### Recovery | ||
| `Default: yes` | ||
|
|
||
| Recovery middleware provides means to recover from panic that are raised in `http.Handler`. A default handler can be |
abhimanyubabbar
approved these changes
Mar 27, 2017
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.