[openwebbeans-meecrowave-examples] 10/28: Better documentation for our examples

[st...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

struberg pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/openwebbeans-meecrowave-examples.git

commit 3d20788433ab17503cb28f48dc9b0509c57a5102
Author: Mark Struberg <st...@apache.org>
AuthorDate: Tue Jul 17 21:38:32 2018 +0200

    Better documentation for our examples
    
    Just playing around how this renders on github ;)
---
 rest-trivial/rest-trivial.adoc | 11 +++++++++++
 rest/pom.xml                   |  1 +
 2 files changed, 12 insertions(+)

diff --git a/rest-trivial/rest-trivial.adoc b/rest-trivial/rest-trivial.adoc
new file mode 100644
index 0000000..b895781
--- /dev/null
+++ b/rest-trivial/rest-trivial.adoc
@@ -0,0 +1,11 @@
+= Apache Meecrowave
+
+== Trivial REST Example
+
+This example shows probably the smallest JavaEE REST Service.
+It is the REST version of the famous 'Hello World' program.
+It contains just a <<src/main/java/com/superbiz/jaxrs/HelloEndpoint.java,Hello Resource>>.
+The important parst of this class are the @Path(`"hello")` and the `@GET' annotated method.
+
+Note that the Resource is a CDI bean annotated with `@ApplicationScoped`.
+Thus only one instance exists.
\ No newline at end of file
diff --git a/rest/pom.xml b/rest/pom.xml
index 6bf61b2..b729df3 100644
--- a/rest/pom.xml
+++ b/rest/pom.xml
@@ -12,4 +12,5 @@
     <artifactId>samples-rest</artifactId>
     <name>REST</name>
 
+
 </project>
\ No newline at end of file