-
Notifications
You must be signed in to change notification settings - Fork 9
Description
Problem Statement
Currently, there is no documentation within the examples/ directory. This creates a small barrier for new users who want to quickly test the library or understand the difference between the provided examples without diving deep into the code logic.
Proposed Solution
I would like to create README.md documentation within the examples/ directory and its subfolders to provide better guidance. This would include:
An Overview: A brief description of what each specific example (e.g., basic, complex) is intended to demonstrate.
Usage Instructions: Clear, copy-pasteable Go commands to run each example locally.
Expected Results: A small snippet showing the expected output (the TOON format) so users can verify their execution was successful.
Alternatives Considered
No response
SPEC Compliance
No response
Additional Context
No response