Skip to content

Commit

Permalink
Improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fugerit79 committed Sep 9, 2024
1 parent f75102a commit f0ad550
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,7 @@ private String toClassName( String base, String splitString ) {
StringBuilder buf = new StringBuilder();
String[] split = base.split( splitString );
for ( String part : split ) {
if ( part.length() > 0 ) {
buf.append( part.substring( 0, 1 ).toLowerCase()+part.substring( 1 ) );
}
buf.append( part.substring( 0, 1 ).toLowerCase()+part.substring( 1 ) );
}
return buf.toString();
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# ${context.artifactId}

## Quickstart

Requirement :
- maven 3.9.x
- java ${context.javaRelease}+

1. Start the app

```shell
mvn mn:run
```

2. Try the app

Open the [openapi-explorer](http://localhost:8080/swagger/views/openapi-explorer)

Test available routes (for instance : [/doc/example.md](http://localhost:8080/doc/example.md))

## Projects notes

the project used as template has been created with the command :

```shell
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,23 @@
# ${context.artifactId}

## Quickstart

Requirement :
- maven 3.9.x
- java ${context.javaRelease}+

1. Start the app

```shell
mvn quarkus:dev
```

2. Try the app

Open the [swagger-ui](http://localhost:8080/q/swagger-ui/)

Test available paths (for instance : [/doc/example.md](http://localhost:8080/doc/example.md))

## Overview

This project has been initialized using [fj-doc-maven-plugin init goal](https://venusguides.fugerit.org/src/docs/wizard/fj-doc-maven-plugin_init.html).
Expand Down

0 comments on commit f0ad550

Please sign in to comment.