-
-
Notifications
You must be signed in to change notification settings - Fork 140
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add tokio-console installation section (#313)
## Description This PR adds a section for installing the tokio-console crate as well as fixes some broken console links. All changes were made to the README. Even though the tokio-console crate has its own README that includes installation, users will likely stumble upon the root README first. Thus, the purpose of this PR is to aid folks who may not wish to clone the repository when trying out the project. ## Commit Notes - Add tokio-console installation section in the README as the primary method of using tokio-console - Move the local cargo run option to its own alternative method section - Update broken console links to use tokio-console in the README - Add ".idea" to gitignore - Update cargo install to use "--locked" flag in the nested README ## Additional Notes Excellent project! Thank you for this. Signed-off-by: Nick Gerace <nickagerace@gmail.com> Co-authored-by: Eliza Weisman <eliza@buoyant.io>
- Loading branch information
1 parent
0045e9b
commit d793903
Showing
3 changed files
with
19 additions
and
6 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,3 +2,4 @@ | |
**/target | ||
**/result | ||
**/*.swp | ||
**/.idea |
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
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