# Meridian

Meridian is a framework for building local first, context aware applications with LLMs.

## Setup
<!-- TODO: Add setup instructions.  -->

<!-- 1. Install the framework in your rust project  -->

<!-- 2. Add necessary API keys (open ai, anthropic and resend) in a .env file  -->

## Getting started

<!-- TODO: Add getting started examples.  -->

<!-- 1. Create a prompt and get a result back using the .get_completion method -->

<!-- 2. Ask the user a question -->

<!-- 3. Ask the user a question and turn the answer into a prompt -->

<!-- 4. Use tools to call external services -->

## Principles
Meridian is built with the following principles in mind:
1. Local first
2. Context is king
3. Tools are your friends
4. Great APIs are the backbone of great software
5. Humans + AI > AI

We love rust and wanted to build a framework that makes it easy to build local, context aware applications with LLM powered agents.

With that in mind, we've built a framework that is easy to understand, easy to use, and easy to extend.

## Features
- Keep humans in the loop with questions and surveys
- Build promts, call LLMs with ease
- Give your AIs some tools to work with
- Manage context locally, in the cloud, or both
- Logs are your friend

