Skip to content

Commit 3ba3b8c

Browse files
committed
Update readme
1 parent cd509e1 commit 3ba3b8c

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# RubyLLM::Template
22

3-
A flexible template management system for [RubyLLM](https://github.com/crmne/ruby_llm) that allows you to organize and reuse ERB templates for AI chat interactions.
3+
A flexible template management system for [RubyLLM](https://github.com/crmne/ruby_llm) that allows you to organize and reuse ERB templates.
4+
5+
```ruby
6+
RubyLLM.chat.with_template(:extract_metadata, document: @document).complete
7+
8+
# Retrieves the following files:
9+
# prompts/
10+
# extract_metadata/
11+
# ├── system.txt.erb # System message
12+
# ├── user.txt.erb # User prompt
13+
# ├── assistant.txt.erb # Assistant message (optional)
14+
# └── schema.rb # RubyLLM::Schema definition (optional)
15+
16+
```
417

518
## Features
619

@@ -16,8 +29,9 @@ A flexible template management system for [RubyLLM](https://github.com/crmne/rub
1629
Add this line to your application's Gemfile:
1730

1831
```ruby
32+
gem 'ruby_llm'
1933
gem 'ruby_llm-template'
20-
gem 'ruby_llm-schema' # For schema.rb support
34+
gem 'ruby_llm-schema' # Optional for schema.rb support
2135
```
2236

2337
And then execute:

0 commit comments

Comments
 (0)