Skip to content

Commit 02063c9

Browse files
authored
Merge pull request #16 from emilrueh/dev
Update README
2 parents ac02c95 + a7aa41f commit 02063c9

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

README.md

+26-25
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,46 @@
22

33
A developer-friendly Lua interface for working with various generative AI providers, abstracting away provider-specific payload structures and response parsing so that using multiple models is easy.
44

5-
## Providers
5+
## Features
66

77
> ⚠️ This is a work in progress so any help is highly appreciated!
88
9+
- Easily switch between AI chat model providers
10+
- Pass in prompts and get replies without the provider complexity
11+
- Easily integrate new models and adjust settings
12+
- Use the `chat` object for integrated message history
13+
- For more granular control use the `genai` client directly if needed
14+
- Stream output for real-time responses
15+
- Structured JSON response abstraction layer
16+
- Token usage tracking with cost calculation
17+
18+
### Providers
19+
920
- [OpenAI](https://platform.openai.com/docs/overview)
1021

1122
- [Anthropic](https://docs.anthropic.com/en/home)
1223

13-
## Features
24+
### Roadmap
1425

15-
- Easily switch between AI chat model providers
16-
- Pass in prompts and get replies without the provider complexity
17-
- Easily integrate new models and adjust settings
18-
- Use the `chat` object for integrated message handling
19-
- Use the `genai` client directly for more granular control if needed
20-
- Abstraction for structured response JSON output
21-
- Token usage tracking with cost calculation
26+
1. Advanced error handling
27+
2. Google Gemini integration
28+
3. Audio models
29+
4. Image models
30+
5. Open-Source model integration
31+
6. Video models
2232

2333
## Installation
2434

2535
```
2636
luarocks install lua-genai
2737
```
2838

39+
### Dependencies
40+
41+
- [lua-cjson](https://github.com/openresty/lua-cjson)
42+
43+
- [luasec](https://github.com/brunoos/luasec)
44+
2945
## Usage
3046

3147
```lua
@@ -76,19 +92,4 @@ local chat = client:chat("gpt-4o-mini", { settings = { json = json_object } })
7692
print(chat:say("Create a powerful wizard called Torben."))
7793
```
7894

79-
See `example.lua` for a full-featured Anthropic implementation.
80-
81-
## Dependencies
82-
83-
- [lua-cjson](https://github.com/openresty/lua-cjson)
84-
85-
- [luasec](https://github.com/brunoos/luasec)
86-
87-
## Roadmap
88-
89-
1. Advanced error handling
90-
2. Google Gemini integration
91-
3. Audio models
92-
4. Image models
93-
5. Open-Source model integration
94-
6. Video models
95+
See `example.lua` for a full-featured Anthropic implementation.

0 commit comments

Comments
 (0)