Skip to content
This repository was archived by the owner on Jul 4, 2025. It is now read-only.

Commit 7cd10f6

Browse files
committed
better format
1 parent d1f8b8b commit 7cd10f6

File tree

1 file changed

+18
-25
lines changed

1 file changed

+18
-25
lines changed

README.md

Lines changed: 18 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,9 @@
1-
Sure, I've reformatted your Markdown text into a code block and fixed some grammar issues:
2-
31
# Nitro - Accelerated AI Inference Engine
42

53
<p align="center">
64
<img alt="nitrologo" src="https://user-images.githubusercontent.com/69952136/266939567-4a7d24f0-9338-4ab5-9261-cb3c71effe35.png">
75
</p>
86

9-
<p align="center">
10-
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
11-
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/janhq/nitro"/>
12-
<img alt="Github Last Commit" src="https://img.shields.io/github/last-commit/janhq/nitro"/>
13-
<img alt="Github Contributors" src="https://img.shields.io/github/contributors/janhq/nitro"/>
14-
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/janhq/nitro"/>
15-
<img alt="Discord" src="https://img.shields.io/discord/1107178041848909847?label=discord"/>
16-
</p>
17-
187
<p align="center">
198
<a href="https://docs.jan.ai/">Getting Started</a> - <a href="https://docs.jan.ai">Docs</a>
209
- <a href="https://docs.jan.ai/changelog/">Changelog</a> - <a href="https://github.com/janhq/nitro/issues">Bug reports</a> - <a href="https://discord.gg/AsJ8krTT3N">Discord</a>
@@ -36,17 +25,22 @@ Sure, I've reformatted your Markdown text into a code block and fixed some gramm
3625

3726
## Quickstart
3827

39-
Step 1: Download Nitro
40-
To use Nitro, download the released binaries from the release page below.
41-
[Download Nitro](https://github.com/janhq/nitro/releases)
28+
**Step 1: Download Nitro**
29+
30+
To use Nitro, download the released binaries from the release page below:
31+
32+
[![Download Nitro](https://img.shields.io/badge/Download-Nitro-blue.svg)](https://github.com/janhq/nitro/releases)
4233

4334
After downloading the release, double-click on the Nitro binary.
4435

45-
Step 2: Download a Model
46-
Download a llama model to try running the llama C++ integration. You can find a "GGUF" model on The Bloke's page below.
47-
[Download Model](https://huggingface.co/TheBloke)
36+
**Step 2: Download a Model**
37+
38+
Download a llama model to try running the llama C++ integration. You can find a "GGUF" model on The Bloke's page below:
39+
40+
[![Download Model](https://img.shields.io/badge/Download-Model-green.svg)](https://huggingface.co/TheBloke)
41+
42+
**Step 3: Run Nitro**
4843

49-
Step 3: Run Nitro
5044
Double-click on Nitro to run it. After downloading your model, make sure it's saved to a specific path. Then, make an API call to load your model into Nitro.
5145

5246
```zsh
@@ -59,9 +53,10 @@ curl -X POST 'http://localhost:3928/inferences/llamacpp/loadmodel' \
5953
"embedding": true
6054
}'
6155
```
62-
ctx_len and ngl are typical llama C++ parameters, and embedding determines whether to enable the embedding endpoint or not.
6356

64-
Step 4: Perform Inference on Nitro for the First Time
57+
`ctx_len` and `ngl` are typical llama C++ parameters, and `embedding` determines whether to enable the embedding endpoint or not.
58+
59+
**Step 4: Perform Inference on Nitro for the First Time**
6560

6661
```zsh
6762
curl --location 'http://localhost:3928/inferences/llamacpp/chat_completion' \
@@ -101,9 +96,7 @@ Nitro is an integration layer with the most cutting-edge inference engine. Its s
10196

10297
### Contact
10398

104-
- For support: please file a GitHub ticket
105-
- For questions: join our Discord [here](https://discord.gg/FTk2MvZwJH)
106-
- For long-form inquiries: please email hello@jan.ai
107-
```
99+
- For support, please file a GitHub ticket.
100+
- For questions, join our Discord [here](https://discord.gg/FTk2MvZwJH).
101+
- For long-form inquiries, please email hello@jan.ai.
108102

109-
I've made formatting improvements and fixed some grammatical issues. If you have any further questions or need additional assistance, please let me know!

0 commit comments

Comments
 (0)