From cb34f730e248411a770557d4e7cd16aab4e28b0d Mon Sep 17 00:00:00 2001 From: 0xSage Date: Mon, 13 Nov 2023 12:49:45 +0800 Subject: [PATCH] docs: update readme --- README.md | 41 +++++++++---------------------- docs/docs/docs/01_introduction.md | 1 + 2 files changed, 13 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 63f60ddf5..94acbb2e1 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,16 @@

- Getting Started - Docs - - Changelog - Bug reports - Discord + Getting Started + - Docs + - Changelog + - Bug reports + - Discord

> ⚠️ **Jan is currently in Development**: Expect breaking changes and bugs! -Jan is a tool to build your own Personal AI, that runs privately on your personal computer. - -Jan is free and open source, under the AGPLv3 license. +Jan is a free, open-source alternative to OpenAI that runs on your personal computer. **Jan runs on any hardware.** From PCs to multi-GPU clusters, Jan supports universal architectures: @@ -43,28 +44,8 @@ _Video: Jan v0.3.0 on Mac Air M2, 16GB Ventura_ ## Quicklinks -- [Developer docs](https://jan.ai/docs) (WIP) -- Mobile App shell: [App Store](https://apps.apple.com/us/app/jan-on-device-ai-cloud-ais/id6449664703) | [Android](https://play.google.com/store/apps/details?id=com.jan.ai) -- [Nitro Github](https://nitro.jan.ai): Jan's AI engine - -## Plugins - -Jan supports core & 3rd party extensions: - -- [x] **LLM chat**: Self-hosted Llama2 and LLMs -- [x] **Model Manager**: 1-click to install, swap, and delete models with HuggingFace integration -- [x] **Storage**: Optionally save conversation history and other data in SQLite -- [ ] **3rd-party AIs**: Connect to ChatGPT, Claude via API Key (in progress) -- [ ] **Cross device support**: Mobile & Web support for custom shared servers (in progress) -- [ ] **File retrieval**: User can chat with docs -- [ ] **Multi-user support**: Share a single server across a team/friends (planned) -- [ ] **Compliance**: Auditing and flagging features (planned) - -## Nitro (Jan's AI engine) - -In the background, Jan runs [Nitro](https://nitro.jan.ai), an open source, C++ inference engine. It runs various model formats (GGUF/TensorRT) on various hardware (Mac M1/M2/Intel, Windows, Linux, and datacenter-grade Nvidia GPUs) with optional GPU acceleration. - -> See the open source Nitro codebase at https://nitro.jan.ai. +- [Developer docs](https://jan.ai/docs) +- [Nitro Github](https://nitro.jan.ai): A C++ inference engine ## Troubleshooting @@ -79,8 +60,6 @@ To reset your installation: OR `rm -rf /Users/$(whoami)/Library/Application\ Support/jan` ---- - ## Contributing Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file @@ -162,3 +141,7 @@ Jan builds on top of other open-source projects: - For discussion: join our Discord [here](https://discord.gg/FTk2MvZwJH) - For business inquiries: email hello@jan.ai - For jobs: please email hr@jan.ai + +## License + +Jan is free and open source, under the AGPLv3 license. diff --git a/docs/docs/docs/01_introduction.md b/docs/docs/docs/01_introduction.md index 0904218da..00d490619 100644 --- a/docs/docs/docs/01_introduction.md +++ b/docs/docs/docs/01_introduction.md @@ -1,5 +1,6 @@ --- title: Introduction +slug: /docs --- Jan can be used to build a variety of AI use cases, at every level of the stack: