Skip to content

Commit 4de3eee

Browse files
filchyfilip.chytil
andauthored
Readme ref (#73)
--------- Co-authored-by: filip.chytil <filip.chytil@firma.seznam.cz>
1 parent 91d9082 commit 4de3eee

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@
77
</div>
88

99
<div align="center">
10-
<h3>Tiny platform for amazing agents</h3>
10+
<h3>Tiny platform for amazing agents</h3>
1111

1212
<h4>
13-
🏠 <a href="https://github.com/filchy/tinygent">Homepage</a> | 📚 <a href="https://filchy.github.io/tinygent">Documentation</a> | 💡 <a href="https://filchy.github.io/tinygent/examples">Examples</a> | 🚀 <a href="https://filchy.github.io/tinygent/examples/quick-start/">Quick Start</a>
13+
<a href="https://github.com/filchy/tinygent">Homepage</a> | <a href="https://filchy.github.io/tinygent">Documentation</a> | <a href="https://filchy.github.io/tinygent/examples">Examples</a> | <a href="https://filchy.github.io/tinygent/examples/quick-start/">Quick Start</a>
1414
</h4>
1515
</div>
1616

17-
🤖 Tinygent is a tiny agentic framework - lightweight, easy to use (hopefully), and efficient (also hopefully ;-0) library for building and deploying generative AI applications. It provides a simple interface for working with various models and tools, making it ideal for developers who want to quickly prototype and deploy AI solutions.
17+
Tinygent is a tiny agentic framework - lightweight, easy to use (hopefully), and efficient (also hopefully ;-0) library for building and deploying generative AI applications. It provides a simple interface for working with various models and tools, making it ideal for developers who want to quickly prototype and deploy AI solutions.
1818

19-
## 🎯 Create an agent
19+
## Create an agent
2020

2121
```python
2222
# uv sync --extra openai
@@ -38,16 +38,16 @@ agent = build_agent(
3838
print(agent.run('What is the weather like in Prague?'))
3939
```
4040

41-
## 🚀 Getting Started
41+
## Getting Started
4242

43-
### 📋 Prerequisites
43+
### Prerequisites
4444

4545
Before you begin using tinygent, ensure that you meet the following software prerequisites.
4646

4747
- Install [Git](https://git-scm.com/)
4848
- Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
4949

50-
### 💻 Install From Source
50+
### Install From Source
5151

5252
1. Clone the tinygent repository to your local machine.
5353
```bash
@@ -80,13 +80,13 @@ Before you begin using tinygent, ensure that you meet the following software pre
8080
uv pip install -e .
8181
```
8282

83-
## 🎬 See It In Action
83+
## See It In Action
8484

8585
<div align="center">
8686
<img alt="TinyChat Demo" src=".github/resources/gifs/demo.gif" width="100%">
8787
</div>
8888

89-
## 🏗️ Architecture
89+
## Architecture
9090

9191
```mermaid
9292
%%{init: {'theme': 'base', 'themeVariables': {'primaryColor': '#e1f5ff', 'primaryTextColor': '#0d47a1', 'primaryBorderColor': '#42a5f5', 'lineColor': '#1976d2', 'secondaryColor': '#fff4e1', 'tertiaryColor': '#f0e1ff'}}}%%
@@ -121,21 +121,21 @@ flowchart LR
121121

122122
Tinygent uses a registry-based plugin architecture: **Packages** register components into the **Runtime**. **Factories** query the Runtime to build **Components** for your code.
123123

124-
## 💡 Examples (Quick Start)
124+
## Examples (Quick Start)
125125

126-
1. 🔑 Ensure you have set the `OPENAI_API_KEY` environment variable to allow the example to use OpenAI's API. An API key can be obtained from [`openai.com`](https://openai.com/).
126+
1. Ensure you have set the `OPENAI_API_KEY` environment variable to allow the example to use OpenAI's API. An API key can be obtained from [`openai.com`](https://openai.com/).
127127
```bash
128128
export OPENAI_API_KEY="your_openai_api_key"
129129
```
130130
131-
2. ▶️ Run the examples using `uv`:
131+
2. Run the examples using `uv`:
132132
```bash
133133
uv run examples/agents/multi-step/main.py
134134
```
135135
136-
3. 🔍 Explore more examples below:
136+
3. Explore more examples below:
137137
138-
### 📚 Features & Examples
138+
### Features & Examples
139139
140140
| Name | Type | Description |
141141
|------|------|-------------|
@@ -163,7 +163,7 @@ Tinygent uses a registry-based plugin architecture: **Packages** register compon
163163
| [Tiny Chat](packages/tiny_chat) | Package | FastAPI-based chat interface |
164164
| [Tiny Graph](packages/tiny_graph) | Package | Neo4j knowledge graph integration |
165165
166-
## Linting & Formatting
166+
## Linting & Formatting
167167
168168
To ensure code quality, formatting consistency, and type safety, run:
169169

0 commit comments

Comments
 (0)