Skip to content

Commit 33298ed

Browse files
docs: update variable naming and improve templating examples in README (#103)
1 parent c6a7227 commit 33298ed

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,19 +96,23 @@ with the usage of the `vars` parameter.
9696
You will be provided with text to translate to {{ language }}.
9797
Respond with nothing but the translated text.
9898
99-
Don't translate the following: {{ never-translate | join(', ') }}
99+
Don't translate the following
100+
{% for item in neverTranslate %}
101+
- {{ item }}
102+
{% endfor %}`
100103
101104
prompt-file: README.md
102105
vars: |
103106
language: Spanish
104-
never-translate:
107+
neverTranslate:
105108
- code blocks
106-
- markdown headers
107109
- image alt text
108110
```
109111
110-
> **Note**: Variables can be used for both `prompt`/`prompt-file` and
111-
> `system-prompt`/`system-prompt-file` inputs.
112+
> [!TIP]
113+
> Variable templating makes most
114+
> sense when using `prompt-file` or `system-prompt-file` inputs, as it allows
115+
> you to maintain reusable prompt templates with dynamic content.
112116

113117
## Permissions 🔒
114118

0 commit comments

Comments
 (0)