doc: update repository README screenshots and help text #422
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
In #421, the screenshots in the `tokio-console` README were updated to match the current code. The contents of the README also go into the docs.rs page. This change updates the two screenshots in the README in the root of the repository. They now match the UI shown by the current code at the latest release of `tokio-console`, 0.1.8. The screenshots are a little bit wider than the ones in the `tokio-console` README as the example `app` from the `console-subscriber` crate was used as the instrumented application and the source file paths are longer. The screenhots are now using relative links directly to the files in the repository. Additionally, the help text in the main README has been updated to reflect what `tokio-console` now produces. This includes additional descriptive text and also mentions how to connect to a Unix domain socket.
hawkw
pushed a commit
that referenced
this pull request
Sep 29, 2023
In #421, the screenshots in the `tokio-console` README were updated to match the current code. The contents of the README also go into the docs.rs page. This change updates the two screenshots in the README in the root of the repository. They now match the UI shown by the current code at the latest release of `tokio-console`, 0.1.8. The screenshots are a little bit wider than the ones in the `tokio-console` README as the example `app` from the `console-subscriber` crate was used as the instrumented application and the source file paths are longer. The screenhots are now using relative links directly to the files in the repository. Additionally, the help text in the main README has been updated to reflect what `tokio-console` now produces. This includes additional descriptive text and also mentions how to connect to a Unix domain socket.
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.
In #421, the screenshots in the
tokio-consoleREADME were updated tomatch the current code. The contents of the README also go into the
docs.rs page.
This change updates the two screenshots in the README in the root of the
repository. They now match the UI shown by the current code at the
latest release of
tokio-console, 0.1.8. The screenshots are a littlebit wider than the ones in the
tokio-consoleREADME as the exampleappfrom theconsole-subscribercrate was used as the instrumentedapplication and the source file paths are longer.
The screenhots are now using relative links directly to the files in the
repository.
Additionally, the help text in the main README has been updated to
reflect what
tokio-consolenow produces. This includes additionaldescriptive text and also mentions how to connect to a Unix domain
socket.