Skip to content

Commit

Permalink
Update README.md completed
Browse files Browse the repository at this point in the history
  • Loading branch information
johnvicinno authored Aug 27, 2024
1 parent e236a28 commit 4d92c2f
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,19 @@ CoderKit is an Xcode Source Editor Extension that provides GitHub Copilot and Co
- Xcode color theme sync to autocompletion panel.
- More features coming soon.

## Prerequisites

- Internet connection.

- Either a GitHub Copilot account or Codeium account:
- [Node](https://nodejs.org/) need to be installed if using Github Copilot.

## Installation and Setup

> 1. Install the app into the Applications folder and run it to set up.
> 2. As promoted, enable the source editor extension in MacOS system settings -> Privacy & Security -> Extensions -> Xcode Source Editor.
> 3. Grant Accessibility API permission to the CoderKit extension app in MacOS system settings -> Privacy & Security -> Accessibility .
> 4. In General tab, select Codeium or GitHub Copilot as your service provider.
> 5. Accordingly, click Codeium or GitHub Copilot tab to follow the screen to set up.

0 comments on commit 4d92c2f

Please sign in to comment.