|
1 |
| -# BaseAI Core SDK |
| 1 | +<p align="center"> |
| 2 | + <a href="https://baseai.dev"> |
| 3 | + <picture> |
| 4 | + <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/LangbaseInc/docs-images/refs/heads/main/baseai/baseai-cover.png"> |
| 5 | + <img src="https://raw.githubusercontent.com/LangbaseInc/docs-images/refs/heads/main/baseai/baseai-cover.png"> |
| 6 | + </picture> |
| 7 | + <h1 align="center">BaseAI</h1> |
| 8 | + </a> |
| 9 | +</p> |
2 | 10 |
|
3 |
| -The AI SDK for building declarative and composable AI-powered LLM products. |
| 11 | +<p align="center"> |
| 12 | + <a aria-label="NPM version" href="https://www.npmjs.com/package/baseai"><img alt="" src="https://img.shields.io/npm/v/@baseai/core?style=for-the-badge&logo=https%3A%2F%2Fraw.githubusercontent.com%2FLangbaseInc%2Fdocs-images%2Frefs%2Fheads%2Fmain%2Fbaseai%2Fbaseai-icon.png&logoColor=%23000&labelColor=%23000&color=%2318181B"></a> |
| 13 | + <a aria-label="License" href="https://github.com/langbaseinc/baseai"><img alt="license" src="https://img.shields.io/npm/l/@baseai/core?style=for-the-badge&logoColor=%23000&labelColor=%23000&color=%2318181B"></a> |
| 14 | +</p> |
4 | 15 |
|
5 |
| -## Documentation |
6 |
| - |
7 |
| -> [!NOTE] |
8 |
| -> Check the [Langbase SDK documentation](https://langbase.com/docs/langbase-sdk/overview) for more details. |
9 |
| -
|
10 |
| -The following examples are for reference only. Prefer docs for the latest information. |
11 |
| - |
12 |
| -## Getting started with `@baseai/core` SDK |
| 16 | +## Getting Started |
13 | 17 |
|
14 |
| -### Installation |
| 18 | +BaseAI is the AI framework for building declarative and composable AI-powered LLM products. It allows you to locally develop AI agents integrated with tools and memory (RAG). Visit our [learn](https://baseai.dev/learn) guide to get started with BaseAI. |
15 | 19 |
|
16 |
| -First, install the `@baseai/core` package using npm, pnpm, or yarn: |
17 |
| - |
18 |
| -```bash |
19 |
| -npm install @baseai/core |
20 |
| -``` |
| 20 | +## Documentation |
21 | 21 |
|
22 |
| -or |
| 22 | +Visit [baseai.dev/docs](https://baseai.dev/docs) for the full documentation. |
23 | 23 |
|
24 |
| -```bash |
25 |
| -pnpm add @baseai/core |
26 |
| -``` |
| 24 | +## Contributing |
27 | 25 |
|
28 |
| -or |
| 26 | +We welcome contributions to BaseAI. Please see our [Contributing Guide](CONTRIBUTING.md) for more information. |
29 | 27 |
|
30 |
| -```bash |
31 |
| -yarn add @baseai/core |
32 |
| -``` |
| 28 | +## Authors |
33 | 29 |
|
34 |
| -## Documentation |
| 30 | +The following are the original authors of BaseAI: |
35 | 31 |
|
36 |
| -Please read the [SDK documentation](https://langbase.com/docs/langbase-sdk/overview) β |
| 32 | +- Ahmad Awais ([@MrAhmadAwais](https://twitter.com/MrAhmadAwais)) |
| 33 | +- Ashar Irfan ([@MrAsharIrfan](https://twitter.com/MrAsharIrfan)) |
| 34 | +- Saqib Ameen ([@SaqibAmeen](https://twitter.com/SaqibAmeen)) |
| 35 | +- Saad Irfan ([@MrSaadIrfan](https://twitter.com/MrSaadIrfan)) |
| 36 | +- Ahmad Bilal ([@AhmadBilalDev](https://twitter.com/ahmadbilaldev)) |
37 | 37 |
|
38 |
| -## Examples |
| 38 | +## Security |
39 | 39 |
|
40 |
| -Check out [more examples in the docs](https://langbase.com/docs/langbase-sdk/examples) β |
| 40 | +If you've found a security vulnerability in BaseAI, please report it privately by emailing [[email protected]](mailto:[email protected]). Please do not open a public issue. For more details on Langbase security and how to report, visit this [link](https://langbase.com/security). |
0 commit comments