Skip to content

Commit aa03fc2

Browse files
committed
docs: update structure to adoc
Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
1 parent 424c6b2 commit aa03fc2

File tree

1 file changed

+36
-22
lines changed

1 file changed

+36
-22
lines changed

README.adoc

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,72 @@
1-
# quarkus-jnosql-mongodb
1+
= quarkus-jnosql-mongodb
22

3-
This project intents to provide a code sample about how to integrate Quarkus with JNoSQL.
3+
This project intends to provide a code sample about how to integrate Quarkus with JNoSQL.
44

55
This project uses Quarkus, the Supersonic Subatomic Java Framework.
66

7-
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
7+
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/
88

9-
## Running the application in dev mode
9+
== Running the application in dev mode
1010

1111
You can run your application in dev mode that enables live coding using:
12-
```shell script
12+
13+
[source,shell]
14+
----
1315
mvn compile quarkus:dev
14-
```
16+
----
1517

16-
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
18+
[NOTE]
19+
====
20+
Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
21+
====
1722

18-
## Packaging and running the application
23+
== Packaging and running the application
1924

2025
The application can be packaged using:
21-
```shell script
26+
27+
[source,shell]
28+
----
2229
mvn package
23-
```
30+
----
31+
2432
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory.
2533
Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory.
2634

2735
The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`.
2836

2937
If you want to build an _über-jar_, execute the following command:
30-
```shell script
38+
39+
[source,shell]
40+
----
3141
mvn package -Dquarkus.package.type=uber-jar
32-
```
42+
----
3343

3444
The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`.
3545

36-
## Creating a native executable
46+
== Creating a native executable
47+
48+
You can create a native executable using:
3749

38-
You can create a native executable using:
39-
```shell script
50+
[source,shell]
51+
----
4052
mvn package -Pnative
41-
```
53+
----
54+
55+
Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
4256

43-
Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
44-
```shell script
57+
[source,shell]
58+
----
4559
mvn package -Pnative -Dquarkus.native.container-build=true
46-
```
60+
----
4761

4862
You can then execute your native executable with: `./target/code-with-quarkus-1.0.0-SNAPSHOT-runner`
4963

5064
If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.
5165

52-
## Provided Code
66+
== Provided Code
5367

54-
### RESTEasy Reactive
68+
=== RESTEasy Reactive
5569

5670
Easily start your Reactive RESTful Web Services
5771

58-
[Related guide section...](https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources)
72+
link:https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources[Related guide section...]

0 commit comments

Comments
 (0)