Skip to content

Commit 26ff457

Browse files
docs(readme): update documentation
1 parent 265669a commit 26ff457

1 file changed

Lines changed: 12 additions & 27 deletions

File tree

README.md

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,36 @@
44

55
[![NPM version](https://img.shields.io/npm/v/code-ollama.svg)](https://www.npmjs.com/package/code-ollama)
66
[![build](https://github.com/ai-action/code-ollama/actions/workflows/build.yml/badge.svg)](https://github.com/ai-action/code-ollama/actions/workflows/build.yml)
7-
[![codecov](https://codecov.io/gh/ai-action/code-ollama/graph/badge.svg?token=B0W2IQZ66A)](https://codecov.io/gh/ai-action/code-ollama)
7+
[![codecov](https://codecov.io/gh/ai-action/code-ollama/graph/badge.svg?token=gRGUasRn2k)](https://codecov.io/gh/ai-action/code-ollama)
88

9-
Ollama Code
9+
🦙 Ollama coding agent that runs in your terminal.
1010

1111
## Quick Start
1212

13-
```ts
14-
import { name } from 'code-ollama';
13+
```sh
14+
npx code-ollama
1515
```
1616

1717
## Install
1818

19-
[NPM](https://www.npmjs.com/package/code-ollama):
19+
Install the [CLI](https://www.npmjs.com/package/code-ollama) globally:
2020

2121
```sh
22-
npm install code-ollama
23-
```
24-
25-
[CDN](https://unpkg.com/browse/code-ollama/):
26-
27-
```html
28-
<script src="https://unpkg.com/code-ollama@latest/dist/index.umd.js"></script>
22+
npm install --global code-ollama
2923
```
3024

3125
## Usage
3226

33-
ES Modules:
27+
Run the CLI:
3428

35-
```ts
36-
import { name } from 'code-ollama';
37-
```
38-
39-
CommonJS:
40-
41-
```ts
42-
const { name } = require('code-ollama');
29+
```sh
30+
code-ollama
4331
```
4432

45-
UMD:
33+
Or use the alias:
4634

47-
```html
48-
<script src="https://unpkg.com/code-ollama@latest/dist/index.umd.js"></script>
49-
<script>
50-
const { name } = window['code-ollama'];
51-
</script>
35+
```sh
36+
collama
5237
```
5338

5439
## License

0 commit comments

Comments
 (0)