Skip to content

Commit 6b429df

Browse files
committed
chore: update readme
1 parent 56a0fdd commit 6b429df

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

README.md

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,56 @@
1818
- [ ] Configure the [CODECOV_TOKEN](https://docs.codecov.com/docs/quick-start) secret for automated test coverage reports on PRs
1919

2020
<!-- Plugin description -->
21-
This Fancy IntelliJ Platform Plugin is going to be your implementation of the brilliant ideas that you have.
2221

23-
This specific section is a source for the [plugin.xml](/src/main/resources/META-INF/plugin.xml) file which will be extracted by the [Gradle](/build.gradle.kts) during the build process.
22+
[GitHub](https://github.com/j-plugins/toon-plugin) | [Telegram](https://t.me/jb_plugins/708) | [Donation](https://github.com/xepozz/xepozz?tab=readme-ov-file#become-a-sponsor) | [Official website](https://toonformat.dev/)
23+
24+
## TOON syntax support
25+
26+
TOON (**T**oken-**O**riented **O**bject **N**otation) syntax support:
27+
28+
- syntax highlighting
29+
- patterns matching (soon)
30+
- indentation support (soon)
31+
- JSON/Yaml <-> TOON converter (soon)
32+
33+
TOON is a compact, human-readable encoding of the JSON data model for LLM prompts.
34+
35+
### Token-Efficient & Accurate
36+
37+
TOON reaches 74% accuracy (vs JSON's 70%) while using ~40% fewer tokens in mixed-structure benchmarks across 4 models.
38+
39+
### JSON Data Model
40+
Encodes the same objects, arrays, and primitives as JSON with deterministic, lossless round-trips.
41+
42+
### LLM-Friendly Guardrails
43+
Explicit [N] lengths and {fields} headers give models a clear schema to follow, improving parsing reliability.
44+
45+
### Minimal Syntax
46+
Uses indentation instead of braces and minimizes quoting, giving YAML-like readability with CSV-style compactness.
47+
48+
### Tabular Arrays
49+
Uniform arrays of objects collapse into tables that declare fields once and stream row values line by line.
50+
51+
### Multi-Language Ecosystem
52+
Spec-driven implementations in TypeScript, Python, Go, Rust, .NET, and other languages.
53+
54+
## Donation
55+
56+
Open-source tools can greatly improve workflows, helping developers and businesses save time and increase revenue.
57+
Many successful projects have been built on these tools, benefiting a wide community.
58+
However, maintaining and enhancing these resources requires continuous effort and investment.
59+
60+
Support from the community helps keep these projects alive and ensures they remain useful for everyone.
61+
Donations play a key role in sustaining and improving these open-source initiatives.
62+
63+
Chose the best option for you to say thank you:
64+
65+
[<img height="28" src="https://github.githubassets.com/assets/patreon-96b15b9db4b9.svg"> Patreon](https://patreon.com/xepozz)
66+
|
67+
[<img height="28" src="https://github.githubassets.com/assets/buy_me_a_coffee-63ed78263f6e.svg"> Buy me a coffee](https://buymeacoffee.com/xepozz)
68+
|
69+
[<img height="28" src="https://boosty.to/favicon.ico"> Boosty](https://boosty.to/xepozz)
2470

25-
To keep everything working, do not remove `<!-- ... -->` sections.
2671
<!-- Plugin description end -->
2772

2873
## Installation

0 commit comments

Comments
 (0)