monacopilot 0.9.14 → 0.9.16

package/README.md

@@ -1,17 +1,179 @@
+![Hero Image](https://i.postimg.cc/PrsQ1KLb/Frame-1.png)
+
 # Monacopilot
 
-[Monaco Editor](https://microsoft.github.io/monaco-editor/) with AI auto-completion, inspired by [GitHub Copilot](https://github.com/features/copilot/).
+**Monacopilot** integrates AI auto-completion into the Monaco Editor, inspired by GitHub Copilot.
+
+## Table of Contents
+
+- [Examples](#examples)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Configuration Options](#configuration-options)
+  - [External Context](#external-context)
+  - [Changing the Provider and Model](#changing-the-provider-and-model)
+  - [Filename](#filename)
+  - [Completions for Specific Technologies](#completions-for-specific-technologies)
+- [Cost Overview](#cost-overview)
+- [FAQ](#faq)
+- [Contributing](#contributing)
+
+## Demo
+
+https://github.com/user-attachments/assets/4af4e24a-1b05-4bee-84aa-1521ad7098cd
+
+## Examples
+
+Here are some examples of how to use Monacopilot in different project setups:
+
+- [Next.js App Router](https://github.com/arshad-yaseen/monacopilot/tree/main/examples/nextjs/app-router)
+- [Next.js Pages Router](https://github.com/arshad-yaseen/monacopilot/tree/main/examples/nextjs/pages-router)
+
+## Installation
+
+To install Monacopilot, run:
+
+```bash
+npm install monacopilot
+```
+
+## Usage
+
+#### Setting Up the API Key
+
+Start by obtaining an API key from the [Groq console](https://console.groq.com/keys). Once you have your API key, define it as an environment variable in your project:
+
+```bash
+# .env.local
+GROQ_API_KEY=your-api-key
+```
+
+#### API Handler
+
+Set up an API handler to manage auto-completion requests. An example using Express.js:
+
+```javascript
+const express = require('express');
+const {Copilot} = require('monacopilot');
+
+const app = express();
+const port = process.env.PORT || 3000;
+const copilot = new Copilot(process.env.GROQ_API_KEY);
+
+app.use(express.json());
+
+app.post('/copilot', async (req, res) => {
+  const completion = await copilot.complete(req.body);
+  res.status(200).json(completion);
+});
+
+app.listen(port);
+```
+
+#### Register Copilot with the Monaco Editor
+
+Next, register Copilot with the Monaco editor.
+
+```javascript
+import * as monaco from 'monaco-editor';
+import {registerCopilot} from 'monacopilot';
+
+const editor = monaco.editor.create(document.getElementById('container'), {
+  language: 'javascript',
+});
 
-## Documentation
+registerCopilot(monaco, editor, {
+  endpoint: 'https://api.example.com/copilot',
+  language: 'javascript',
+});
+```
 
-[https://monacopilot.vercel.app/docs](https://monacopilot.vercel.app/docs)
+## Configuration Options
+
+### External Context
+
+Enhance the accuracy and relevance of Copilot's completions by providing additional code context from your workspace.
+
+```javascript
+registerCopilot(monaco, editor, {
+  // ...other options
+  externalContext: [
+    {
+      path: './utils.js',
+      content:
+        'export const reverse = (str) => str.split("").reverse().join("")',
+    },
+  ],
+});
+```
+
+By providing external context, Copilot can offer more intelligent suggestions. For example, if you start typing `const isPalindrome = `, Copilot may suggest using the `reverse` function from `utils.js`.
+
+### Changing the Provider and Model
+
+You can specify a different provider and model for completions by setting the `provider` and `model` parameters in the `Copilot` instance.
+
+```javascript
+const copilot = new Copilot(process.env.OPENAI_API_KEY, {
+  provider: 'openai',
+  model: 'gpt-4o',
+});
+```
+
+The default provider is `groq` and the default model is `llama-3-70b`.
+
+| Provider | Model       | Description                                       | Avg. Response Time |
+| -------- | ----------- | ------------------------------------------------- | ------------------ |
+| Groq     | llama-3-70b | Fast and efficient, suitable for most tasks       | <0.5s              |
+| OpenAI   | gpt-4o-mini | Mini version of gpt-4o, cheaper                   | 1.5-3s             |
+| OpenAI   | gpt-4o      | Highly intelligent, ideal for complex completions | 1-2s               |
+
+### Filename
+
+Specify the name of the file being edited to receive more contextually relevant completions.
+
+```javascript
+registerCopilot(monaco, editor, {
+  // ...other options
+  filename: 'utils.js', // e.g., "index.js", "utils/objects.js"
+});
+```
+
+Now, the completions will be more relevant to utilities.
+
+### Completions for Specific Technologies
+
+Enable completions tailored to specific technologies by using the `technologies` option.
+
+```javascript
+registerCopilot(monaco, editor, {
+  // ...other options
+  technologies: ['react', 'next.js', 'tailwindcss'],
+});
+```
+
+This configuration will provide completions relevant to React, Next.js, and Tailwind CSS.
+
+## Cost Overview
+
+The cost of completions is very affordable. See the table below for an estimate of the costs you will need to pay for completions.
+
+| Provider | Model       | Avg. Cost per 1000 Code Completions |
+| -------- | ----------- | ----------------------------------- |
+| Groq     | llama-3-70b | $0.939                              |
+| OpenAI   | gpt-4o-mini | $0.821                              |
+| OpenAI   | gpt-4o      | $3.46                               |
+
+> **Note:** Currently, Groq does not implement billing, allowing free usage of their API. During this free period, you will experience minimal rate limiting and some latency in completions. You can opt for Groq's enterprise plan to benefit from increased rate limits and get quick completions without visible latency.
+
+## FAQ
+
+### Is AI Auto Completion Free?
+
+You use your own Groq or OpenAI API key for AI auto-completion. The cost of completions is very affordable, and we implement various methods to minimize these costs as much as possible. Costs vary depending on the model you use; see this [cost overview](#cost-overview) for an idea of the cost.
 
 ## Contributing
 
 For guidelines on contributing, Please read the [contributing guide](https://github.com/arshad-yaseen/monacopilot/blob/main/CONTRIBUTING.md).
 
 We welcome contributions from the community to enhance Monacopilot's capabilities and make it even more powerful ❤️
-
-## Security
-
-MonacoPilot does not store or use your code; it only provides AI completions.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monacopilot",
-  "version": "0.9.14",
+  "version": "0.9.16",
   "description": "AI auto-completion for Monaco Editor",
   "main": "./build/index.js",
   "module": "./build/index.mjs",
@@ -12,7 +12,6 @@
     "build": "tsup src/index.ts",
     "dev": "tsup src/index.ts --watch",
     "dev:test": "pnpm -C test dev",
-    "dev:docs": "pnpm -C docs dev",
     "type-check": "tsc --noEmit",
     "lint": "eslint . --ext .ts,.tsx --fix",
     "lint:test": "pnpm -C test lint",