update usage documentation #100
Open
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
noxecane
suggested changes
Jul 6, 2021
allengblack
suggested changes
Jul 19, 2021
README.md
Outdated
| @@ -49,6 +49,65 @@ const server = new InversifyExpressServer(container, null); | |||
| }) | |||
| ``` | |||
|
|
|||
| ## What is SiberMetrics and how it works. | |||
|
|
|||
| SiberMetrics are routers around prometheus client for node.js to record and export a histogram of an http request. | |||
There was a problem hiding this comment.
Routers or "wrappers"?
There was a problem hiding this comment.
Capitalise Prometheus, NodeJS.
| @@ -49,6 +49,65 @@ const server = new InversifyExpressServer(container, null); | |||
| }) | |||
| ``` | |||
|
|
|||
| ## What is SiberMetrics and how it works. | |||
There was a problem hiding this comment.
It's not quite a "histogram of an HTTP request".
https://prometheus.io/docs/introduction/overview/
allengblack
reviewed
Jul 27, 2021
| @@ -23,7 +23,7 @@ export class IncompleteEnvError extends Error { | |||
| * keys. | |||
| * @param schema schema to use for validation | |||
| */ | |||
| export function autoloadEnv<T extends AppConfig>(schema: ObjectSchema): T { | |||
| export function autoloadEnv<T>(schema: ObjectSchema): T { | |||
There was a problem hiding this comment.
Why did you change these?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes