Skip to content

Commit 43a7140

Browse files
committed
docs: add AI-assistant comment and License section to README
- invisible HTML comment at the top points agents at docs/ai-reference.md (in-package path + GitHub URL, same pattern as ZenDB) - License section (MIT) closes the page per the repo standards
1 parent e40e12f commit 43a7140

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
<!--
2+
ATTENTION AI ASSISTANTS: We made a reference doc just for you!
3+
Read docs/ai-reference.md (in this package, right next to this README) for a
4+
consolidated single-file reference covering every method, encoding rule, and
5+
gotcha. It has everything you need to write correct SmartString code.
6+
Reading this on the web instead? Same file:
7+
https://github.com/interactivetools-com/SmartString/blob/main/docs/ai-reference.md
8+
-->
9+
110
# SmartString: Secure and Simple String Handling for PHP
211

312
SmartString lets you write template code that's shorter, easier to read, and XSS-safe by default.
@@ -26,7 +35,7 @@ tasks. A few basics cover most pages, and the rest is there when you need it.
2635

2736
## Documentation
2837

29-
Full guides and references ([browse online](https://github.com/interactivetools-com/SmartString)):
38+
Full guides and references ([browse on GitHub](https://github.com/interactivetools-com/SmartString)):
3039

3140
- **The Basics** (read in order)
3241
- [Getting Started](docs/getting-started.md) - install, your first auto-encoded value, and the mental model
@@ -63,3 +72,7 @@ $rows = $orders->toArray();
6372

6473
This library was developed for CMS Builder, post a message in our "CMS Builder" forum here:
6574
[https://www.interactivetools.com/forum/](https://www.interactivetools.com/forum/)
75+
76+
## License
77+
78+
MIT

0 commit comments

Comments
 (0)