Skip to content

Commit e7901e5

Browse files
committed
Update README.md
1 parent 1851e1c commit e7901e5

File tree

1 file changed

+5
-66
lines changed

1 file changed

+5
-66
lines changed

README.md

Lines changed: 5 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,9 @@
1-
# MAML — Minimal Abstract Markup Language
1+
# MAML
22

3-
**MAML** is a minimal and efficient markup language designed to be straightforward to parse and easy to write.
3+
Minimal. Human-readable. Machine-parsable.
44

5-
---
5+
See [maml.dev](https://maml.dev) for more information and specification.
66

7-
## ✨ Why MAML?
7+
## License
88

9-
* **Minimal** → No unnecessary symbols, noise, or quirks.
10-
* **Readable** → Intuitive syntax that feels natural for humans.
11-
* **Familiar** → Inspired by JSON, but with a modern twist.
12-
* **Efficient** → Lightweight and fast, from small configs to massive APIs.
13-
* **Extensible** → Scales across projects, tools, and environments.
14-
15-
---
16-
17-
## 🔍 Example
18-
19-
20-
```maml
21-
{
22-
project: "MAML"
23-
tags: [
24-
"minimal"
25-
"readable"
26-
]
27-
28-
# A simple nested object
29-
spec: {
30-
version: 1
31-
author: "Anton Medvedev"
32-
}
33-
34-
# Array of objects with nested objects
35-
examples: [
36-
{
37-
json: {
38-
name: "JSON"
39-
born: 2001
40-
}
41-
}
42-
]
43-
44-
notes: """
45-
This is a multiline strings.
46-
Keeps formatting as-is.
47-
"""
48-
}
49-
```
50-
51-
---
52-
53-
## ⚖️ MAML vs Others
54-
55-
| Feature | JSON | YAML | TOML | **MAML** |
56-
|-------------------|-----------|-----------|-----------|--------------|
57-
| Human readability | ⚠️ Medium | ✅ High | ✅ High | ✅✅ Very High |
58-
| Verbosity | ❌ High | ⚠️ Medium | ✅ Low | ✅ Very Low |
59-
| Parsing speed | ✅ Fast | ⚠️ Medium | ✅ Fast | ✅ Fast |
60-
| Learning curve | ✅ Easy | ❌ Tricky | ⚠️ Medium | ✅ Easy |
61-
62-
---
63-
64-
## 🌍 Philosophy
65-
66-
MAML follows one simple rule:
67-
**Data should be effortless to write, read, and share.**
68-
69-
Whether you’re configuring apps, defining APIs, or structuring data at scale, MAML is here to make your workflow faster,
70-
cleaner, and smarter.
9+
[MIT](LICENSE)

0 commit comments

Comments
 (0)