Skip to content

Commit

Permalink
Merge pull request #145 from lastmile-ai/pr145
Browse files Browse the repository at this point in the history
[Docs] Update Readme and minor algolia update
  • Loading branch information
saqadri authored Nov 10, 2023
2 parents 360cdf8 + 7839538 commit 5a76a9a
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 2 deletions.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,50 @@
<div align="center"><picture>
<img alt="aiconfig" src="aiconfig-docs/static/img/readme_logo.png">
</picture></div>
<br/>

![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
<!-- <div align="right"><a href="https://aiconfig.lastmileai.dev">Go to Docs</a></div> -->

## 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
Expand Down
2 changes: 1 addition & 1 deletion aiconfig-docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ const config = {
},
algolia: {
appId: "MXLMDZIH1G",
apiKey: "63a53b045dfcdc2b7b4319d4d67a1edb",
apiKey: "ed56ae054b0f8ac02ef281e34584cc3c",
indexName: "aiconfig",
contextualSearch: true,
},
Expand Down
Binary file added aiconfig-docs/static/img/readme_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5a76a9a

Please sign in to comment.