Improve the README #12
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
DXTimer
reviewed
Oct 21, 2024
| @@ -1,6 +1,10 @@ | |||
| # Metrics API for [erldns](https://github.com/dnsimple/erldns) | |||
| # Metrics API for [erldns] | |||
There was a problem hiding this comment.
I see the link has been removed but we still keep the [] around was this intentional?
There was a problem hiding this comment.
Yes if you have a footnote in Markdown, like
[erldns]: https://...anywhere on the page, then you can just use [erldns] instead of [erldns][erldns] 🙃
DXTimer
reviewed
Oct 21, 2024
|
|
||
| This app provides an HTTP API for gathering and querying metrics from an erldns server and presenting those metrics as JSON. | ||
| This app provides an HTTP API for gathering and querying metrics from an [erldns] server and presenting those metrics as JSON. |
DXTimer
approved these changes
Oct 21, 2024
DXTimer
added
the
enhancement
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.
It took me a sec to figure out how this was meant to run and why, so I figured a note in the README wouldn't hurt. 🙃