From 4d92c2f595d8cdbdc24bbc15fc8661e957ac9fb7 Mon Sep 17 00:00:00 2001 From: johnvicinno Date: Tue, 27 Aug 2024 11:26:42 -0400 Subject: [PATCH] Update README.md completed --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 5e115bf..7df727e 100644 --- a/README.md +++ b/README.md @@ -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. + +