Skip to content

Commit 82713bd

Browse files
authored
Merge pull request #63 from thanglequoc/AddGitHubPage
feat: Update GH Page
2 parents 6c2d121 + f4123bf commit 82713bd

6 files changed

Lines changed: 46 additions & 13 deletions

File tree

docs/_sass/_code.scss

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@
4040
}
4141

4242
.code-panel--before .code-panel__header {
43-
background: rgba($accent-red, 0.06);
43+
background: rgba($accent-red, 0.08);
4444
color: $accent-red;
4545
}
4646

4747
.code-panel--after .code-panel__header {
48-
background: rgba($primary, 0.06);
49-
color: $primary;
48+
background: rgba($primary, 0.10);
49+
color: $primary-dark;
5050
}
5151

5252
.code-panel__body {

docs/_sass/_hero.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
justify-content: center;
1111
text-align: center;
1212
overflow: hidden;
13-
background: linear-gradient(135deg, #f0fafa 0%, #e0f4f4 30%, #f5f9fa 60%, #e8f6f6 100%);
13+
background: linear-gradient(135deg, #f2f6f7 0%, #e6eff1 30%, #f5f7f8 60%, #eaf0f2 100%);
1414
padding-top: var(--navbar-height);
1515
}
1616

docs/_sass/_variables.scss

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ $primary-glow: rgba(70, 191, 198, 0.25);
1010

1111
// Light mode
1212
$light-bg: #ffffff;
13-
$light-surface: #f5fafa;
14-
$light-surface-alt: #eaf5f5;
13+
$light-surface: #f4f7f8;
14+
$light-surface-alt: #e8eef0;
1515
$light-text: #1a2b3c;
16-
$light-text-muted: #5a6b7c;
17-
$light-border: #d4e8e8;
18-
$light-code-bg: #f0f6f6;
19-
$light-code-border: #d4e8e8;
16+
$light-text-muted: #4d5f6f;
17+
$light-border: #c8d5d9;
18+
$light-code-bg: #f3f5f7;
19+
$light-code-border: #c8d5d9;
2020
$light-card-bg: #ffffff;
21-
$light-card-shadow: rgba(70, 191, 198, 0.08);
21+
$light-card-shadow: rgba(70, 191, 198, 0.12);
2222

2323
// Dark mode
2424
$dark-bg: #0d1520;

docs/getting-started.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,22 @@ dependencies {
8787
</plugin>
8888
```
8989

90+
### Set Up Logging Output
91+
92+
Timer Ninja uses **SLF4J** for logging. Depending on your project, choose one of the following:
93+
94+
**Spring Boot projects** — no extra setup needed. Spring Boot ships with Logback, so Timer Ninja output will appear in your logs automatically.
95+
96+
**Non-Spring projects with an SLF4J provider** — if you already have Logback, Log4j2, or another SLF4J-compatible logging framework, you're good to go. Just make sure the log level for `io.github.thanglequoc.timerninja.TimerNinjaUtil` is at least `INFO`.
97+
98+
**No logging framework?** — enable System.out output at application startup:
99+
100+
```java
101+
TimerNinjaConfiguration.getInstance().toggleSystemOutLog(true);
102+
```
103+
104+
This prints trace output directly to the console — useful for quick testing or simple console applications.
105+
90106
---
91107

92108
## Annotation-based Tracking

docs/index.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<span class="badge">Open Source &middot; Java Library</span>
1616
</div>
1717
<h1 class="hero__title animate-fade-up">
18-
Measure <span class="text-gradient">Java Method Execution Time</span><br>with a Single Annotation
18+
Measure <span class="text-gradient">Java Code Execution Time</span><br>with a Single Annotation
1919
</h1>
2020
<p class="hero__subtitle animate-fade-up">
2121
Track code execution time in Java effortlessly. Get a full call hierarchy with timing &amp; arguments — no heavy tracing frameworks required.
@@ -302,6 +302,7 @@ <h3>Annotate Your Methods</h3>
302302
<div class="step-card__content">
303303
<h3>Run &amp; See the Trace &#128007;</h3>
304304
<p>Execute your code — Timer Ninja automatically logs the execution trace.</p>
305+
<p style="font-size: 0.9rem; opacity: 0.85;"><strong>Note:</strong> Timer Ninja uses SLF4J. Spring Boot projects work out of the box. For other projects without a logging provider, enable console output with <code>TimerNinjaConfiguration.getInstance().toggleSystemOutLog(true)</code>.</p>
305306
<pre><code>public void processPayment(User user, int amount) - 770 ms
306307
|-- public boolean changeAmount(User user, int amount) - 306 ms
307308
|-- public void notify(User user) - 258 ms</code></pre>
@@ -317,7 +318,7 @@ <h3>Run &amp; See the Trace &#128007;</h3>
317318
<div class="hero__mascot animate-fade-up" style="width: 100px; height: 100px;">
318319
<img src="{{ '/assets/images/mascot.png' | relative_url }}" alt="Timer Ninja mascot">
319320
</div>
320-
<h2 class="animate-fade-up">Ready to <span class="text-gradient">Track Like a Ninja</span>?</h2>
321+
<h2 class="animate-fade-up">Ready to <span class="text-gradient">track them all?</span>?</h2>
321322
<p class="animate-fade-up" style="max-width: 560px; margin: 0 auto 2rem; font-size: 1.1rem;">
322323
Block tracking, custom thresholds, constructor tracking, and more — explore all features in the docs and start measuring Java method execution time the smart way.
323324
</p>

wiki/Getting-Started.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,22 @@ dependencies {
7575
</plugin>
7676
```
7777

78+
### Set Up Logging Output
79+
80+
Timer Ninja uses **SLF4J** for logging. Depending on your project, choose one of the following:
81+
82+
**Spring Boot projects** — no extra setup needed. Spring Boot ships with Logback, so Timer Ninja output will appear in your logs automatically.
83+
84+
**Non-Spring projects with an SLF4J provider** — if you already have Logback, Log4j2, or another SLF4J-compatible logging framework, you're good to go. Just make sure the log level for `io.github.thanglequoc.timerninja.TimerNinjaUtil` is at least `INFO`.
85+
86+
**No logging framework?** — enable System.out output at application startup:
87+
88+
```java
89+
TimerNinjaConfiguration.getInstance().toggleSystemOutLog(true);
90+
```
91+
92+
This prints trace output directly to the console — useful for quick testing or simple console applications.
93+
7894
---
7995

8096
## Annotation-based Tracking

0 commit comments

Comments
 (0)