diff --git a/docs/docs/docs/README.md b/docs/docs/docs/README.md index a1d1fc233..a82a8a801 100644 --- a/docs/docs/docs/README.md +++ b/docs/docs/docs/README.md @@ -42,28 +42,30 @@ Read more: Jan's data persistence happens on the user's local filesystem. -We implemented abstractions on top of `fs` and other core modules in an opinionated way, s.t. user data is saved in a folder based way that allows for easy packaging and exporting. +We implemented abstractions on top of `fs` and other core modules in an opinionated way, s.t. user data is saved in a folder-based framework that lets users easily package, export, and manage their data. Read more: -- [Jan fs wrapper](https://github.com/janhq/jan/blob/main/core/src/fs.ts) +- [Folder-based fs wrapper](https://github.com/janhq/jan/blob/main/core/src/fs.ts) +- [Piping Node modules across infrastructures](https://github.com/janhq/jan/tree/main/core/src/node) ### AI Native All software applications can be natively supercharged with an embedded AI server and AI abstractions. -The core SDK provides: +Including: -- Native and common AI [types](https://github.com/janhq/jan/tree/main/core/src/types) and [core extensions](https://github.com/janhq/jan/tree/main/core/src/extensions) to support common AI functionality like making an inference call. -- An OpenAI compatible API definition that is autogenerated from code -- A lightweight, embedded C++ [inference engine](https://github.com/janhq/jan/tree/main/extensions/inference-nitro-extension) that is ready to be used. - -Read more: +- OpenAI Compatible AI [types](https://github.com/janhq/jan/tree/main/core/src/types) and [core extensions](https://github.com/janhq/jan/tree/main/core/src/extensions) to support common functionality like making an inference call. +- A lightweight, embedded C++ [inference engine](https://github.com/janhq/jan/tree/main/extensions/inference-nitro-extension) that's immediately callable from code. - [Code Entrypoint](https://github.com/janhq/jan/tree/main/core/src/api) ## Fun Project Ideas -- `GAme engine`: We think the Core SDK can be a cool AI game engine +Beyond the current Jan client and UX, the Core SDK can be used to build many other AI-powered and privacy preserving applications. + +- `Game engine`: For AI enabled character games, procedural generation games +- `Health app`: For a personal healthcare app that improves habits +- Got ideas? Make a PR into this docs page! If you are interested to tackle these issues, or have suggestions for integrations and other OSS tools we can use, please hit us up in [Discord](https://discord.gg/5rQ2zTv3be).