Skip to content

Commit

Permalink
docs: Fix title and high level features to top
Browse files Browse the repository at this point in the history
  • Loading branch information
timonv committed Jan 5, 2025
1 parent 823dcd5 commit cc4899c
Showing 1 changed file with 18 additions and 14 deletions.
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,26 @@

<!--toc:start-->

- [About The Project](#about-the-project)
- [What is Swiftide?](#what-is-swiftide)
- [High level features](#high-level-features)
- [Latest updates on our blog :fire:](#latest-updates-on-our-blog-fire)
- [Example](#example)
- [Examples](#examples)
- [Vision](#vision)
- [Features](#features)
- [In detail](#in-detail)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage and concepts](#usage-and-concepts)
- [Indexing](#indexing)
- [Querying](#querying)
- [Roadmap](#roadmap)
- [Community](#community)
- [Contributing](#contributing)
- [License](#license)
<!--toc:end-->

</details>
</details>

<a name="readme-top"></a>

Expand Down Expand Up @@ -69,12 +73,22 @@ Fast, streaming, indexing, query, and agent library for building LLM application

<!-- ABOUT THE PROJECT -->

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## What is Swiftide?

<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->

Swiftide is a Rust library for building LLM applications, enabling fast data ingestion, transformation, and indexing for effective querying and prompt injection, known as Retrieval Augmented Generation. It provides flexible building blocks for creating various agents, allowing rapid development from concept to production with minimal code.

### High level features

- Build fast, streaming indexing and querying pipelines
- Easily build agents, mix and match with previously built pipelines
- A modular and extendable API, with minimal abstractions
- Integrations with popular LLMs and storage providers
- Ready to use pipeline transformations

<div align="center">
<img src="https://github.com/bosun-ai/swiftide/blob/master/images/rag-dark.svg" alt="RAG" width="100%" >
</div>
Expand All @@ -88,16 +102,6 @@ We <3 feedback: project ideas, suggestions, and complaints are very welcome. Fee
<p align="right">(<a href="#readme-top">back to top</a>)</p>

## High level features

- Build fast, streaming indexing and querying pipelines
- Easily build agents, mix and match with previously built pipelines
- A modular and extendable API, with minimal abstractions
- Integrations with popular LLMs and storage providers
- Ready to use pipeline transformations

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Latest updates on our blog :fire:

- [Evaluate Swiftide pipelines with Ragas](https://bosun.ai/posts/evaluating-swiftide-with-ragas/) (2024-09-15)
Expand Down Expand Up @@ -177,7 +181,7 @@ _You can find more detailed examples in [/examples](https://github.com/bosun-ai/

## Vision

Our goal is to create a fast, extendable platform for building LLLM applications in Rust, to further the development of automated AI applications, with an easy-to-use and easy-to-extend api.
Our goal is to create a fast, extendable platform for building LLM applications in Rust, to further the development of automated AI applications, with an easy-to-use and easy-to-extend api.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down

0 comments on commit cc4899c

Please sign in to comment.