wip: README edits

Author: toby

README.md

@@ -1,53 +1,16 @@
 # GitHub MCP Server
 
-GitHub MCP Server implemented in Go.
+The GitHub MCP Server is a Model Context Protocol (MCP) server that provides seamless integration with GitHub's APIs, enabling advanced automation and interaction capabilities for developers and tools.
 
-## Setup
+## Use Cases
 
-Create a GitHub Personal Access Token with the appropriate permissions
-and set it as the GITHUB_PERSONAL_ACCESS_TOKEN environment variable.
+- Automating GitHub workflows and processes.
+- Extracting and analyzing data from GitHub repositories.
+- Building AI powered tools and applications that interact with GitHub's ecosystem.
 
-## Testing in VS Code Insiders
+## Installation
 
-### Requirements
-
-You can either use a Docker image or build the binary from the repo.
-
-#### Docker image
-
-As of now, this repo is private, and hence the docker image is not available publicly. To pull it,
-you need to make sure you can access the GitHub docker registry. See [this](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic)
-for more details.
-
-To make sure you can access the GitHub docker registry, run the following command:
-
-```bash
-docker pull ghcr.io/github/github-mcp-server:main
-```
-
-If the above command works, you are good to go.
-
-#### Build from repo
-First, install `github-mcp-server` by cloning the repo and running the following command:
-
-```bash
-go install ./cmd/github-mcp-server
-```
-
-If you don't want to clone the repo, you can run:
-
-```bash
-GOPRIVATE=github.com/github go install github.com/github/github-mcp-server/cmd/github-mcp-server@latest
-```
-
-This will install the `github-mcp-server` binary in your `$GOPATH/bin` directory.
-
-Find where the binary is installed by running:
-
-```bash
-# note this assumes $GOPATH/bin is in your $PATH
-which github-mcp-server
-```
+[Create a GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with the appropriate permissions and set it as the `GITHUB_PERSONAL_ACCESS_TOKEN` environment variable.
 
 ### Start VS Code Insiders
 
@@ -351,7 +314,7 @@ The flag `--gh-host` and the environment variable `GH_HOST` can be used to set t
 
 ### Repository Content
 
-- **Get Repository Content**  
+- **Get Repository Content**
   Retrieves the content of a repository at a specific path.
 
   - **Template**: `repo://{owner}/{repo}/contents{/path*}`
@@ -360,7 +323,7 @@ The flag `--gh-host` and the environment variable `GH_HOST` can be used to set t
     - `repo`: Repository name (string, required)
     - `path`: File or directory path (string, optional)
 
-- **Get Repository Content for a Specific Branch**  
+- **Get Repository Content for a Specific Branch**
   Retrieves the content of a repository at a specific path for a given branch.
 
   - **Template**: `repo://{owner}/{repo}/refs/heads/{branch}/contents{/path*}`
@@ -370,7 +333,7 @@ The flag `--gh-host` and the environment variable `GH_HOST` can be used to set t
     - `branch`: Branch name (string, required)
     - `path`: File or directory path (string, optional)
 
-- **Get Repository Content for a Specific Commit**  
+- **Get Repository Content for a Specific Commit**
   Retrieves the content of a repository at a specific path for a given commit.
 
   - **Template**: `repo://{owner}/{repo}/sha/{sha}/contents{/path*}`
@@ -380,7 +343,7 @@ The flag `--gh-host` and the environment variable `GH_HOST` can be used to set t
     - `sha`: Commit SHA (string, required)
     - `path`: File or directory path (string, optional)
 
-- **Get Repository Content for a Specific Tag**  
+- **Get Repository Content for a Specific Tag**
   Retrieves the content of a repository at a specific path for a given tag.
 
   - **Template**: `repo://{owner}/{repo}/refs/tags/{tag}/contents{/path*}`
@@ -390,7 +353,7 @@ The flag `--gh-host` and the environment variable `GH_HOST` can be used to set t
     - `tag`: Tag name (string, required)
     - `path`: File or directory path (string, optional)
 
-- **Get Repository Content for a Specific Pull Request**  
+- **Get Repository Content for a Specific Pull Request**
   Retrieves the content of a repository at a specific path for a given pull request.
 
   - **Template**: `repo://{owner}/{repo}/refs/pull/{pr_number}/head/contents{/path*}`