Skip to content

Commit 0820e08

Browse files
committed
docs: update titles in readme
1 parent 0787a27 commit 0820e08

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ HTTP headers into responses, implementing the [W3C Server Timing specification](
1010
It automatically tracks controller action time, view rendering time, and total request time – surfacing them directly in
1111
your browser's DevTools.
1212

13-
## Documentation
13+
## 📖 Documentation
1414

1515
Full documentation is available at the [project documentation site](https://grails-plugins.github.io/grails-server-timing/).
1616
This includes architecture details, the W3C specification, security considerations, and browser DevTools usage guides.
1717

18-
## Quick Start
18+
## 🚀 Quick Start
1919

2020
Add the dependency to your `build.gradle`:
2121

@@ -66,7 +66,7 @@ dependencies {
6666
> Snapshot versions are unstable and may change without notice. They are intended for testing
6767
> upcoming changes before a release.
6868
69-
## How It Works
69+
## How It Works
7070

7171
The plugin intercepts HTTP requests using a servlet filter and a Grails interceptor:
7272

@@ -87,7 +87,7 @@ Server-Timing: total;dur=156.3;desc="Total", action;dur=45.2;desc="Action", view
8787
| Controller with render (JSON, text) | `total`, `action` |
8888
| Static assets / other resources | `total`, `other` |
8989

90-
## Viewing in Browser DevTools
90+
## 🌐 Viewing in Browser DevTools
9191

9292
Open DevTools (F12), go to the **Network** tab, click a request, and select the **Timing** tab. Metrics
9393
appear under "Server Timing":
@@ -96,7 +96,7 @@ appear under "Server Timing":
9696
- **Firefox** 61+
9797
- **Safari** 16.4+
9898

99-
## Configuration
99+
## ⚙️ Configuration
100100

101101
Configure in `application.yml` under `grails.plugins.servertiming`:
102102

@@ -121,13 +121,13 @@ environments:
121121
enabled: false
122122
```
123123
124-
## Compatibility
124+
## 🤝 Compatibility
125125
126126
| Plugin Version | Grails | Java | Groovy |
127127
|----------------|--------|------|--------|
128128
| 0.x | 7.0.x | 17+ | 4.0.x |
129129
130-
## Building from Source
130+
## 🔨 Building from Source
131131
132132
Prerequisites: [SDKMAN!](https://sdkman.io/)
133133
@@ -138,7 +138,7 @@ sdk env install # Install Java 17, Gradle 8.14, Groovy 4.0
138138

139139
See [CONTRIBUTING.md](CONTRIBUTING.md) for the full development setup.
140140

141-
## Contributing
141+
## 💡 Contributing
142142

143143
Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) before submitting a pull request.
144144

0 commit comments

Comments
 (0)