Skip to content

Commit a77e50b

Browse files
authored
Merge pull request #903 from janhq/ashley/update-README
Update README.md
2 parents 7de6d18 + 863c459 commit a77e50b

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Jan - Own Your AI
1+
# Jan - Bring AI to your Desktop
22

33
![Jan banner](https://github.com/janhq/jan/assets/89722390/35daac7d-b895-487c-a6ac-6663daaad78e)
44

@@ -21,7 +21,7 @@
2121

2222
> ⚠️ **Jan is currently in Development**: Expect breaking changes and bugs!
2323
24-
Jan is a free, open-source alternative to OpenAI's platform that runs on a local folder of open-format files.
24+
Jan is an open-source ChatGPT alternative that runs 100% offline on your computer.
2525

2626
**Jan runs on any hardware.** From PCs to multi-GPU clusters, Jan supports universal architectures:
2727

@@ -36,22 +36,32 @@ Jan is a free, open-source alternative to OpenAI's platform that runs on a local
3636
## Demo
3737

3838
<p align="center">
39-
<video src="https://github.com/janhq/jan/assets/89722390/47988dcc-13ed-4ca0-87f7-74d00f4d47d8">
39+
<video src="https://github.com/janhq/jan/assets/89722390/43adfddc-7980-4ae6-b544-719f04660dd7">
4040
</video>
4141
</p>
4242

43-
_Video: Jan v0.3.0 on Mac Air M2, 16GB Ventura_
4443

45-
## Quicklinks
44+
_Video: Jan v0.4.0 on Mac Air M2, 16GB Ventura_
4645

46+
## Quicklinks
47+
#### Jan
48+
- [Jan website](https://jan.ai/)
49+
- [Jan Github](https://github.com/janhq/jan)
4750
- [User Guides](https://jan.ai/docs)
48-
- [Developer docs](https://jan.ai/docs)
49-
- [API reference](https://jan.ai/api/overview)
50-
- [Nitro Github](https://nitro.jan.ai): Nitro is a C++ inference engine
51+
- [Developer docs](https://jan.ai/docs/extensions/)
52+
- [API reference](https://jan.ai/api-reference/)
53+
- [Specs](https://jan.ai/specs/)
54+
55+
#### Nitro:
56+
Nitro is a high-efficiency C++ inference engine for edge computing, powering Jan. It is lightweight and embeddable, ideal for product integration.
57+
- [Nitro Website](https://nitro.jan.ai)
58+
- [Nitro Github](https://github.com/janhq/nitro)
59+
- [Documentation](https://nitro.jan.ai/docs)
60+
- [API Reference](https://nitro.jan.ai/api-reference)
5161

5262
## Troubleshooting
5363

54-
As Jan is development mode, you might get stuck on a broken build.
64+
As Jan is in development mode, you might get stuck on a broken build.
5565

5666
To reset your installation:
5767

0 commit comments

Comments
 (0)