Skip to content

Commit 817deea

Browse files
update README to...
- include Table of Contents header - include HTMX in the TOC - update benchmark command - update Contributing description
1 parent e36301b commit 817deea

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
Write HTML using Swift Macros.
1+
Write HTML using Swift Macros. Supports HTMX via global attributes.
22

33
<a href="https://swift.org"><img src="https://img.shields.io/badge/Swift-5.9+-F05138?style=&logo=swift" alt="Requires at least Swift 5.9"></a> <img src="https://img.shields.io/badge/Platforms-Any-gold"> <a href="https://discord.com/invite/VyuFQUpcUz"><img src="https://img.shields.io/badge/Chat-Discord-7289DA?style=&logo=discord"></a> <a href="https://github.com/RandomHashTags/swift-htmlkit/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-Apache_2.0-blue" alt="Apache 2.0 License"></a>
44

5+
## Table of Contents
56
- [Why](#why)
67
- [Usage](#usage)
78
- [Basic](#basic)
89
- [Advanced](#advanced)
10+
- [HTMX](#htmx)
911
- [Benchmarks](#benchmarks)
1012
- [Static](#static)
1113
- [Dynamic](#dynamic)
@@ -240,7 +242,7 @@ string = #div(attributes: [.htmx(.ext("ws")), .htmx(.ws(.send(true)))])
240242

241243
Test machine: iMac (i9 9900k, 72GB RAM, 2TB) running macOS 15.0 with the Swift 6 compiler.
242244

243-
Executed command: `swift package -c release --allow-writing-to-package-directory benchmark --target Benchmarks --metric throughput --format jmh`
245+
Executed command: `swift package --allow-writing-to-package-directory benchmark --target Benchmarks --metric throughput --format jmh`
244246

245247
### Static
246248
<img src="Benchmarks/img/throughput_static.png">
@@ -252,4 +254,8 @@ Executed command: `swift package -c release --allow-writing-to-package-directory
252254
This library is the clear leader in performance & efficiency. Static webpages offer the best performance, while dynamic pages still tops the charts (I am actively researching and testing improvements for dynamic pages).
253255

254256
## Contributing
255-
Create a PR.
257+
Contributions are always welcome.
258+
259+
Please try to use this library's syntax when creating a PR.
260+
261+
Changes in syntax **must** solve real-word problems to be accepted.

0 commit comments

Comments
 (0)