diff --git a/src/crewai_tools/tools/github_search_tool/README.md b/src/crewai_tools/tools/github_search_tool/README.md index 220e0aeb8..e6f47e082 100644 --- a/src/crewai_tools/tools/github_search_tool/README.md +++ b/src/crewai_tools/tools/github_search_tool/README.md @@ -1,24 +1,24 @@ -# GitHubSearchTool +# GithubSearchTool ## Description -The GitHubSearchTool is a Read, Append, and Generate (RAG) tool specifically designed for conducting semantic searches within GitHub repositories. Utilizing advanced semantic search capabilities, it sifts through code, pull requests, issues, and repositories, making it an essential tool for developers, researchers, or anyone in need of precise information from GitHub. +The GithubSearchTool is a Read, Append, and Generate (RAG) tool specifically designed for conducting semantic searches within GitHub repositories. Utilizing advanced semantic search capabilities, it sifts through code, pull requests, issues, and repositories, making it an essential tool for developers, researchers, or anyone in need of precise information from GitHub. ## Installation -To use the GitHubSearchTool, first ensure the crewai_tools package is installed in your Python environment: +To use the GithubSearchTool, first ensure the crewai_tools package is installed in your Python environment: ```shell pip install 'crewai[tools]' ``` -This command installs the necessary package to run the GitHubSearchTool along with any other tools included in the crewai_tools package. +This command installs the necessary package to run the GithubSearchTool along with any other tools included in the crewai_tools package. ## Example -Here’s how you can use the GitHubSearchTool to perform semantic searches within a GitHub repository: +Here’s how you can use the GithubSearchTool to perform semantic searches within a GitHub repository: ```python -from crewai_tools import GitHubSearchTool +from crewai_tools import GithubSearchTool # Initialize the tool for semantic searches within a specific GitHub repository -tool = GitHubSearchTool( +tool = GithubSearchTool( github_repo='https://github.com/example/repo', content_types=['code', 'issue'] # Options: code, repo, pr, issue ) @@ -26,7 +26,7 @@ tool = GitHubSearchTool( # OR # Initialize the tool for semantic searches within a specific GitHub repository, so the agent can search any repository if it learns about during its execution -tool = GitHubSearchTool( +tool = GithubSearchTool( content_types=['code', 'issue'] # Options: code, repo, pr, issue ) ```