-
-
+✨ If you would like to help spread the word about Rig, please consider starring the repo!
> [!WARNING]
> Here be dragons! Rig is **alpha** software and **will** contain breaking changes as it evolves. We'll annotate them and highlight migration paths as we encounter them.
## What is Rig?
-Rig is a Rust library for building scalable, modular, and ergonomic LLM-powered applications.
+Rig is a Rust library for building scalable, modular, and ergonomic **LLM-powered** applications.
More information about this crate can be found in the [crate documentation](https://docs.rs/rig-core/latest/rig/).
-We'd love your feedback. Please take a moment to let us know what you think using this [Feedback form](https://bit.ly/Rig-Feeback-Form).
+Help us improve Rig by contributing to our [Feedback form](https://bit.ly/Rig-Feeback-Form).
## Table of contents
@@ -49,12 +48,14 @@ We'd love your feedback. Please take a moment to let us know what you think usin
- Simple but powerful common abstractions over LLM providers (e.g. OpenAI, Cohere) and vector stores (e.g. MongoDB, in-memory)
- Integrate LLMs in your app with minimal boilerplate
-## Installation
+
+
+## Get Started
```bash
cargo add rig-core
```
-## Simple example:
+### Simple example:
```rust
use rig::{completion::Prompt, providers::openai};
@@ -78,14 +79,22 @@ async fn main() {
Note using `#[tokio::main]` requires you enable tokio's `macros` and `rt-multi-thread` features
or just `full` to enable all features (`cargo add tokio --features macros,rt-multi-thread`).
+You can find more examples in the [`/examples`](./examples) directory. More detailed use cases walkthroughs are regularly published on our [Dev.to Blog](https://dev.to/0thtachi).
+
## Integrations
-Rig supports the following LLM providers natively:
-- OpenAI
-- Cohere
-- Anthropic
-- Perplexity
-- Google Gemini
-
-Additionally, Rig currently has the following integration sub-libraries:
-- MongoDB vector store: `rig-mongodb`
-- LanceDB vector store: `rig-lancedb`
+
+| Model Providers | Vector Stores |
+|:--------------:|:-------------:|
+| |
|
+
+
+Vector stores are available as separate companion-crates:
+- MongoDB vector store: [`rig-mongodb`](https://github.com/playgrounds-ai/rig-mongodb)
+- LanceDB vector store: [`rig-lancedb`](https://github.com/playgrounds-ai/rig-lancedb)
+
+
+
+
+
+
+
diff --git a/img/built-by-playgrounds.svg b/img/built-by-playgrounds.svg
new file mode 100644
index 00000000..09cfa521
--- /dev/null
+++ b/img/built-by-playgrounds.svg
@@ -0,0 +1 @@
+
diff --git a/img/by-playgrounds.svg b/img/by-playgrounds.svg
new file mode 100644
index 00000000..7e4b1c4b
--- /dev/null
+++ b/img/by-playgrounds.svg
@@ -0,0 +1 @@
+
diff --git a/img/rig+playgrounds_dark_blue.png b/img/rig+playgrounds_dark_blue.png
deleted file mode 100644
index ea3f2352..00000000
Binary files a/img/rig+playgrounds_dark_blue.png and /dev/null differ
diff --git a/img/rig+playgrounds_white_blue.svg b/img/rig+playgrounds_white_blue.svg
deleted file mode 100644
index d8957786..00000000
--- a/img/rig+playgrounds_white_blue.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/img/rig-playgrounds-dark.svg b/img/rig-playgrounds-dark.svg
new file mode 100644
index 00000000..f9cad286
--- /dev/null
+++ b/img/rig-playgrounds-dark.svg
@@ -0,0 +1 @@
+
diff --git a/img/rig+playgrounds_dark_blue.svg b/img/rig-playgrounds-light.svg
similarity index 86%
rename from img/rig+playgrounds_dark_blue.svg
rename to img/rig-playgrounds-light.svg
index 150bc7ce..4e9e2b91 100644
--- a/img/rig+playgrounds_dark_blue.svg
+++ b/img/rig-playgrounds-light.svg
@@ -1 +1 @@
-
\ No newline at end of file
+
diff --git a/rig-lancedb/README.md b/rig-lancedb/README.md
index d63c7115..9694e3c3 100644
--- a/rig-lancedb/README.md
+++ b/rig-lancedb/README.md
@@ -29,4 +29,4 @@ rig-core = "0.2.1"
You can also run `cargo add rig-lancedb rig-core` to add the most recent versions of the dependencies to your project.
-See the [examples](./examples) folder for usage examples.
+See the [`/examples`](./examples) folder for usage examples.
diff --git a/rig-mongodb/README.md b/rig-mongodb/README.md
index 5d4dd1aa..381e3dac 100644
--- a/rig-mongodb/README.md
+++ b/rig-mongodb/README.md
@@ -31,4 +31,4 @@ rig-core = "0.2.1"
You can also run `cargo add rig-mongodb rig-core` to add the most recent versions of the dependencies to your project.
-See the [examples](./examples) folder for usage examples.
+See the [`/examples`](./examples) folder for usage examples.
+ 
@@ -11,29 +11,28 @@
+
+
-
-
+
+
| 
|
+
+
+Vector stores are available as separate companion-crates:
+- MongoDB vector store: [`rig-mongodb`](https://github.com/playgrounds-ai/rig-mongodb)
+- LanceDB vector store: [`rig-lancedb`](https://github.com/playgrounds-ai/rig-lancedb)
+
+
+
+