diff --git a/README.md b/README.md index 0655717b..6abffbf3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,18 @@ -[![Crate](https://img.shields.io/crates/v/rig-core.svg)](https://crates.io/crates/rig-core) +
+ -# Rig +## What is Rig? 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/). @@ -9,9 +21,11 @@ We'd love your feedback. Please take a moment to let us know what you think usin ## Table of contents +- [What is Rig?](#what-is-rig) +- [Table of contents](#table-of-contents) - [High-level features](#high-level-features) -- [Installation](#) -- [Simple Example](#simple-example) +- [Installation](#installation) +- [Simple example:](#simple-example) - [Integrations](#integrations) ## High-level features diff --git a/img/rig_logo.svg b/img/rig_logo.svg new file mode 100644 index 00000000..be08ccc0 --- /dev/null +++ b/img/rig_logo.svg @@ -0,0 +1,20 @@ + + \ No newline at end of file