Skip to content

Commit

Permalink
nits
Browse files Browse the repository at this point in the history
  • Loading branch information
irfanpena committed May 31, 2024
1 parent cb75995 commit e99945b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Ensure that your system meets the following requirements to run Cortex:

## Quickstart
To install Cortex CLI, follow the steps below:
1. Install the Cortex NPM package:
1. Install the Cortex NPM package globally:
``` bash
npm i -g @janhq/cortex
```
Expand All @@ -75,11 +75,11 @@ cortex init

3. Download a GGUF model from Hugging Face:
``` bash
cortex models pull janhq/TinyLlama-1.1B-Chat-v1.0-GGUF
cortex pull tinyllama:1b
```
4. Load the model:
``` bash
cortex models start janhq/TinyLlama-1.1B-Chat-v1.0-GGUF
cortex models start tinyllama:1b
```

5. Start chatting with the model:
Expand Down
13 changes: 7 additions & 6 deletions cortex-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ Ensure that your system meets the following requirements to run Cortex:
- **Disk**: At least 10GB for app and model download.

## Quickstart
1. Install the NPM package:
To install Cortex CLI, follow the steps below:
1. Install the Cortex NPM package globally:
``` bash
npm i -g @janhq/cortex
```
Expand All @@ -72,16 +73,16 @@ npm i -g @janhq/cortex
cortex init
```

3. Download a GGUF model from Hugging Face
3. Download a GGUF model from Hugging Face:
``` bash
cortex models pull janhq/TinyLlama-1.1B-Chat-v1.0-GGUF
cortex pull tinyllama:1b
```
4. Load the model
4. Load the model:
``` bash
cortex models start janhq/TinyLlama-1.1B-Chat-v1.0-GGUF
cortex models start tinyllama:1b
```

5. Start chatting with the model
5. Start chatting with the model:
``` bash
cortex chat tell me a joke
```
Expand Down

0 comments on commit e99945b

Please sign in to comment.