Skip to content

Commit 5c8004f

Browse files
committed
docs: improve library documentation
1 parent 88a0444 commit 5c8004f

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,33 @@ array(2) {
134134
}
135135
```
136136

137+
To retrieve already parsed `llms.txt` object instances, pass the `parse` flag to the available extraction methods.
138+
139+
140+
Value of `$llmsTxts` when parsed:
141+
142+
```php
143+
array(2) {
144+
[0]=>
145+
object(Stolt\LlmsTxt\LlmsTxt)#11 (5) {
146+
["hasBeenParsed":"Stolt\LlmsTxt\LlmsTxt":private]=>
147+
bool(true)
148+
["title":"Stolt\LlmsTxt\LlmsTxt":private]=>
149+
string(22) "first llms.txt content"
150+
["description":"Stolt\LlmsTxt\LlmsTxt":private]=>
151+
string(0) ""
152+
["details":"Stolt\LlmsTxt\LlmsTxt":private]=>
153+
string(0) ""
154+
["sections":"Stolt\LlmsTxt\LlmsTxt":private]=>
155+
array(0) {
156+
}
157+
}
158+
[1]=> // ... ommitted for brevity
159+
}
160+
```
161+
162+
163+
137164
### Running tests
138165

139166
``` bash

0 commit comments

Comments
 (0)