diff --git a/README.md b/README.md index 7c282e0bb..63f5d7fb7 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,50 @@ +
+ aiconfig +
+
+ ![Python](https://github.com/lastmile-ai/aiconfig/actions/workflows/pr_python.yml/badge.svg) ![Node](https://github.com/lastmile-ai/aiconfig/actions/workflows/pr_typescript.yml/badge.svg) ![Docs](https://github.com/lastmile-ai/aiconfig/actions/workflows/test-deploy-docs.yml/badge.svg) -# AIConfig Tools: Configuring and Interacting AIConfigs + ## Overview AIConfig Tools is a package that simplifies Prompt, Model, and Parameter Management by allowing you to create and manage AIConfigs. +> Full documentation: **[aiconfig.lastmileai.dev](https://aiconfig.lastmileai.dev/)** + +## Install + +Install with your favorite package manager for Node or Python. + +### Node.js + +#### `npm` or `yarn` + +```bash +npm install aiconfig +``` + +```bash +yarn add aiconfig +``` + +### Python + +#### `pip` or `poetry` + +```bash +pip install python-aiconfig +``` + +```bash +poetry add python-aiconfig +``` + +[Detailed installation instructions](https://aiconfig.lastmileai.dev/docs/introduction/getting-started/#installation). + ### Table of Contents 1. Installation diff --git a/aiconfig-docs/docusaurus.config.js b/aiconfig-docs/docusaurus.config.js index f34efe0d3..a2e28f1de 100644 --- a/aiconfig-docs/docusaurus.config.js +++ b/aiconfig-docs/docusaurus.config.js @@ -169,7 +169,7 @@ const config = { }, algolia: { appId: "MXLMDZIH1G", - apiKey: "63a53b045dfcdc2b7b4319d4d67a1edb", + apiKey: "ed56ae054b0f8ac02ef281e34584cc3c", indexName: "aiconfig", contextualSearch: true, }, diff --git a/aiconfig-docs/static/img/readme_logo.png b/aiconfig-docs/static/img/readme_logo.png new file mode 100644 index 000000000..e983399dd Binary files /dev/null and b/aiconfig-docs/static/img/readme_logo.png differ