diff --git a/README.md b/README.md index 9c686c4c2f..3331d70d99 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Jan - Own Your AI +# Jan - Bring AI to your Desktop ![Jan banner](https://github.com/janhq/jan/assets/89722390/35daac7d-b895-487c-a6ac-6663daaad78e) @@ -21,7 +21,7 @@ > ⚠️ **Jan is currently in Development**: Expect breaking changes and bugs! -Jan is a free, open-source alternative to OpenAI's platform that runs on a local folder of open-format files. +Jan is an open-source ChatGPT alternative that runs 100% offline on your computer. **Jan runs on any hardware.** From PCs to multi-GPU clusters, Jan supports universal architectures: @@ -36,22 +36,32 @@ Jan is a free, open-source alternative to OpenAI's platform that runs on a local ## Demo

-

-_Video: Jan v0.3.0 on Mac Air M2, 16GB Ventura_ -## Quicklinks +_Video: Jan v0.4.0 on Mac Air M2, 16GB Ventura_ +## Quicklinks +#### Jan +- [Jan website](https://jan.ai/) +- [Jan Github](https://github.com/janhq/jan) - [User Guides](https://jan.ai/docs) -- [Developer docs](https://jan.ai/docs) -- [API reference](https://jan.ai/api/overview) -- [Nitro Github](https://nitro.jan.ai): Nitro is a C++ inference engine +- [Developer docs](https://jan.ai/docs/extensions/) +- [API reference](https://jan.ai/api-reference/) +- [Specs](https://jan.ai/specs/) + +#### Nitro: +Nitro is a high-efficiency C++ inference engine for edge computing, powering Jan. It is lightweight and embeddable, ideal for product integration. +- [Nitro Website](https://nitro.jan.ai) +- [Nitro Github](https://github.com/janhq/nitro) +- [Documentation](https://nitro.jan.ai/docs) +- [API Reference](https://nitro.jan.ai/api-reference) ## Troubleshooting -As Jan is development mode, you might get stuck on a broken build. +As Jan is in development mode, you might get stuck on a broken build. To reset your installation: