Add instruction for how to upgrade slither in the CLI

[CJ42]

Just added a small instruction under the "Install with Git" part, so that developer know how to easily upgrade Slither in their CLI to keep up with the latest features / bug fixes releases.

Summary by CodeRabbit

• Documentation
  • Updated README with instructions for upgrading the Slither version to access the latest features and bug fixes.

[coderabbitai]

Walkthrough

Walkthrough

The changes to the project primarily involve updates to the README.md file with instructions on upgrading the Slither version. These updates aim to ensure users have access to the latest features and bug fixes associated with the tool. There are no changes to the declarations of exported or public entities in the codebase.

Changes

File	Change Summary
README.md	Added instructions for upgrading the Slither version

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 798c1f6 and 1099e68.

Files selected for processing (1)

• README.md (1 hunks)

Additional context used

LanguageTool

README.md

[uncategorized] ~45-~45: Do not mix variants of the same word (‘analyse’ and ‘analyze’) within a single text. (EN_WORD_COHERENCY)
Context: ...lithIR)) enables simple, high-precision analyses * Correctly parses 99.9% of all public ...

---

[uncategorized] ~193-~193: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ...tional | High 76 | low-level-calls | [Low level calls](https://github.com/crytic/slithe...

---

[uncategorized] ~222-~222: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...Quick Review Printers * human-summary: [Print a human-readable summary of the ...

---

[uncategorized] ~229-~229: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...In-Depth Review Printers * call-graph: [Export the call-graph of the contracts...

---

[grammar] ~230-~230: The noun should probably be in the singular form. (EVERY_EACH_SINGULAR)
Context: ...graph) * cfg: [Export the CFG of each functions](https://github.com/trailofbits/slither...

---

[uncategorized] ~241-~241: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... Tools * slither-check-upgradeability: [Review delegatecall-based upgradeabi...

---

[style] ~258-~258: The phrase ‘feel free to’ is used quite frequently. Consider using a less frequent alternative to set your writing apart from others and make it sound more professional. (FEEL_FREE_TO_STYLE_ME)
Context: ...lither/slither.html). ## Getting Help Feel free to stop by our [Slack channel](https://emp...

---

[uncategorized] ~263-~263: Do not mix variants of the same word (‘analyse’ and ‘analyze’) within a single text. (EN_WORD_COHERENCY)
Context: ...cribes how to write a new vulnerability analyses. * The [API documentation](https://git...

---

[misspelling] ~304-~304: Possible spelling mistake found. (EN_MULTITOKEN_SPELLING_TWO)
Context: ...detect loops | Chunmiao Li, Shijie Nie, Yang Cao, Yijun Yu, Zhenjiang Hu | IEEE Open J. ...

---

[typographical] ~307-~307: Two consecutive dots (DOUBLE_PUNCTUATION)
Context: ...t tokens' features (mintable, pausable, ..) | Mazorra, Bruno, Victor Adan, and Van...

---

[typographical] ~312-~312: Two consecutive dots (DOUBLE_PUNCTUATION)
Context: ...tures (CFG, function, parameters types, ..) | Qing Huang, Dianshu Liao, Zhenchang ...

---

[duplication] ~313-~313: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ...uild state access graphs | Xiaodong Qi, Jiao Jiao, Yi Li | International Conference on Di...

Additional comments not posted (1)

README.md (1)

79-83: Clear and Useful Upgrade Instructions

The added instructions for upgrading Slither using pip are clear and effectively communicate the necessary steps to keep the tool updated. This is a valuable addition for users who need to stay current with the latest features and bug fixes.

[CJ42]

Closing as did not checked out from dev branch. Re-open in #2498