Skip to content

Commit

Permalink
Add feature section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
QubitPi committed Jan 17, 2025
1 parent 5672537 commit c29f44a
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 6 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ __Jersey Webservice Template__ (__JWT__) is a [JSR 370] webservice template that
through [GitHub templates]. One can think of JWT as the Jersey/Jetty version of [Spring Initializr]. At the end of the
day, JWT helps organization to improve the velocity and quality of their teams' work

✨ Features
-----------

- Out-of-the-box healthcheck endpoint
- Docusaurus-based documentation site freely hosted on GitHub Pages
- Dockerized webservice
- ELK application monitoring
- Flexible webservice configuration

Quick Start
-----------

Expand Down
10 changes: 6 additions & 4 deletions docs/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,12 @@ applies

:::

That's it. A healthcheck endpoint is now ready at localhost:8080/v1/data/healthcheck. At this point, JWT has generated
a Java webservice project with just what we need to start quickly. Developer can now start adding business value and
__get work done much faster in a standard way__. The following sections of this documentation contain further details on
how to proceed next.
After Creating the Repository
-----------------------------

At this point, JWT has generated a Java webservice project with just what we need to start quickly. Developer can now
start adding business value and __get work done much faster in a standard way__. The following sections of this
documentation contain further details on how to proceed next.

- [Development](development)
- [Configuration](configuration)
Expand Down
4 changes: 2 additions & 2 deletions docs/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ function HomepageHeader() {
{siteConfig.title}
</Heading>
<p className="hero__subtitle">
You can <b><em>innovate</em></b> given the <b><em>right technology</em></b>
We can <b><em>innovate</em></b> given the <b><em>right technology</em></b>
</p>
<div className={styles.buttons}>
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Documentation
Start Adding Business Values
</Link>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ class DockerITSpec extends Specification {
}
}

@Deprecated
private static boolean isLocal() {
return System.properties['os.name'] as String in LOCAL_ENVS
}
Expand Down

0 comments on commit c29f44a

Please sign in to comment.