Skip to content

Commit e443b48

Browse files
authored
docs: readme rework (#33)
1 parent 1c1ed9a commit e443b48

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
LLM Chain
22
=========
33

4-
Simple PHP toolkit for building LLM chains.
4+
PHP library for building LLM-based features and applications.
55

6-
This is not stable nor production ready, it's just a playground for me to experiment with LLMs.
7-
Abstractions, concepts and interfaces are not good at all and will definitely change.
6+
This is not a stable library yet, but still rather experimental. Feel free to try it out, give feedback, ask questions, contribute or share your use cases.
7+
Abstractions, concepts and interfaces are not final and potentially subject of change.
88

99
Requirements
1010
------------
@@ -13,12 +13,14 @@ Requirements
1313
Installation
1414
------------
1515

16-
The recommended way to install LlmChain is through [Composer](http://getcomposer.org/):
16+
The recommended way to install LLM Chain is through [Composer](http://getcomposer.org/):
1717

1818
```bash
1919
composer require php-llm/llm-chain
2020
```
2121

22+
When using Symfony Framework, check out the integration bundle [php-llm/llm-chain-bundle](https://github.com/php-llm/llm-chain-bundle).
23+
2224
Supported Models & Runtimes
2325
---------------------------
2426

@@ -61,7 +63,7 @@ Usage Examples
6163
--------------
6264

6365
See [examples](examples) to run example implementations using this library.
64-
Depending on the example you need to export needed environment variables for API keys or deployment configurations:
66+
Depending on the example you need to export different environment variables for API keys or deployment configurations:
6567

6668
### Chat Examples
6769

@@ -86,7 +88,7 @@ Depending on the example you need to export needed environment variables for API
8688
php examples/chat-claude-anthropic.php
8789
```
8890

89-
### ToolChain Examples
91+
### Tool Examples
9092

9193
1. Simple Clock Tool
9294
```bash
@@ -126,3 +128,8 @@ Depending on the example you need to export needed environment variables for API
126128
export OPENAI_API_KEY=sk-...
127129
php examples/structured-output-math.php
128130
```
131+
132+
Contributions
133+
-------------
134+
135+
Constributions are always welcome.

0 commit comments

Comments
 (0)