Skip to content

Commit 83acc09

Browse files
committed
docs: improve library documentation
1 parent 88a0444 commit 83acc09

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,30 @@ 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+
```php
140+
array(2) {
141+
[0]=>
142+
object(Stolt\LlmsTxt\LlmsTxt)#11 (5) {
143+
["hasBeenParsed":"Stolt\LlmsTxt\LlmsTxt":private]=>
144+
bool(true)
145+
["title":"Stolt\LlmsTxt\LlmsTxt":private]=>
146+
string(22) "first llms.txt content"
147+
["description":"Stolt\LlmsTxt\LlmsTxt":private]=>
148+
string(0) ""
149+
["details":"Stolt\LlmsTxt\LlmsTxt":private]=>
150+
string(0) ""
151+
["sections":"Stolt\LlmsTxt\LlmsTxt":private]=>
152+
array(0) {
153+
}
154+
}
155+
[1]=> // ... ommitted for brevity
156+
}
157+
```
158+
159+
160+
137161
### Running tests
138162

139163
``` bash

0 commit comments

Comments
 (0)