Skip to content

Commit

Permalink
Readme file cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jamesbognar
jamesbognar committed Sep 10, 2019
1 parent 54689d2 commit ec767d9
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 241 deletions.
19 changes: 17 additions & 2 deletions README.md
View file
Expand Up @@ -13,6 +13,21 @@
***************************************************************************************************************************
-->

# Juneau
# Juneau Petstore

Please visit the [home page](http://juneau.apache.org) for more information about this project.
A sample application that shows the capabilities of the Juneau REST platform with Spring Boot and other technologies
to produce end-to-end REST microservices.

Juneau provides the following capabilities:

- Ability to serialize/parse Java POJOs to a wide variety of languages.
- Ability to construct REST interfaces using annotated POJOs.
- Ability to create Java interface proxies against remote REST interfaces.

The project is broken down into the following subprojects:

- juneau-petstore-api - Contains the Java interface and DTOs for the petstore application.
- juneau-petstore-server - Contains the server-side Java implementation of the petstore Java interface as a REST resource.
- juneau-petstore-client - Contains the client-side Java proxy of the petstore Java interface.

More information for this project can be found [here](http://juneau.apache.org/index.html#petstore.html)
21 changes: 0 additions & 21 deletions juneau-petstore-api/pom.xml
View file
Expand Up @@ -72,27 +72,6 @@
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<escapeString>\</escapeString>
</configuration>
<executions>
<execution>
<id>juneau-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<finalName>juneau-examples-petstore-api-${project.version}</finalName>
<descriptors>
<descriptor>src/assembly/bin.xml</descriptor>
</descriptors>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand Down
58 changes: 0 additions & 58 deletions juneau-petstore-api/src/assembly/bin.xml
View file

This file was deleted.

21 changes: 0 additions & 21 deletions juneau-petstore-client/pom.xml
View file
Expand Up @@ -72,27 +72,6 @@
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<escapeString>\</escapeString>
</configuration>
<executions>
<execution>
<id>juneau-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<finalName>juneau-petstore-client-${project.version}</finalName>
<descriptors>
<descriptor>src/assembly/bin.xml</descriptor>
</descriptors>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand Down
21 changes: 0 additions & 21 deletions juneau-petstore-server/pom.xml
View file
Expand Up @@ -113,27 +113,6 @@
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<escapeString>\</escapeString>
</configuration>
<executions>
<execution>
<id>juneau-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<finalName>juneau-petstore-server-${project.version}</finalName>
<descriptors>
<descriptor>src/assembly/bin.xml</descriptor>
</descriptors>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>

Expand Down
123 changes: 5 additions & 118 deletions pom.xml
View file
Expand Up @@ -131,76 +131,6 @@

<pluginManagement>
<plugins>

<!-- Generates the javadocs for all non-test projects. -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.4</version>
<configuration>
<additionalJOptions>
<additionalJOption>-J-DjuneauVersion=${juneauVersion}</additionalJOption>
<additionalJOption>-J-DjuneauVersionNext=${juneauVersionNext}</additionalJOption>
</additionalJOptions>
<show>protected</show>
<windowtitle>${project.name} ${project.version}</windowtitle>
<author>true</author>
<linksource>true</linksource>
<source>1.8</source>
<bootclasspath>${sun.boot.class.path}</bootclasspath>
<overview>${basedir}/juneau-doc/src/main/javadoc/overview.html</overview>
<stylesheetfile>${basedir}/juneau-doc/src/main/javadoc/javadoc.css</stylesheetfile>
<use>false</use>
<additionalparam>-sourcetab 3 -notimestamp -Xdoclint:none --allow-script-in-comments</additionalparam>
<verbose>false</verbose>
<excludePackageNames>*proto*:*test*:org.apache.juneau.doc.internal</excludePackageNames>
<linksource>true</linksource>
<links>
<link>https://docs.oracle.com/javase/8/docs/api/</link>
<link>https://docs.oracle.com/javaee/5/api/</link>
</links>
<docfilessubdirs>true</docfilessubdirs>
<javadocDirectory>${basedir}/juneau-doc/src/main/javadoc</javadocDirectory>
<taglets>
<taglet>
<tagletClass>org.apache.juneau.doc.internal.DocTag</tagletClass>
<tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
</taglet>
<taglet>
<tagletClass>org.apache.juneau.doc.internal.PropertyTag</tagletClass>
<tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
</taglet>
<taglet>
<tagletClass>org.apache.juneau.doc.internal.FragmentTag</tagletClass>
<tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
</taglet>
<taglet>
<tagletClass>org.apache.juneau.doc.internal.SourceTag</tagletClass>
<tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
</taglet>

<!--org.apache.juneau.doc.internal.DocTag</taglet-->
<!-- taglet>org.apache.juneau.doc.internal.PropertyTag</taglet-->
</taglets>
<tagletpath>${basedir}/juneau-doc/juneau-doc.jar</tagletpath>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
<execution>
<id>aggregate</id>
<phase>site</phase>
<goals>
<goal>aggregate</goal>
</goals>
</execution>
</executions>
</plugin>

<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
Expand Down Expand Up @@ -239,63 +169,20 @@
</plugins>
</pluginManagement>
</build>

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.4</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jxr-plugin</artifactId>
<version>2.5</version>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-report-plugin</artifactId>
<version>2.18</version>
<configuration>
<aggregate>true</aggregate>
</configuration>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.2</version>
<configuration>
<excludes>
<exclude>**/doc/**/*</exclude>
<exclude>**/examples/**/*</exclude>
<exclude>**/testutils/**/*</exclude>
</excludes>
<fileSets>
<fileSet implementation="org.apache.maven.shared.model.fileset.FileSet">
<directory>${project.parent.build.directory}</directory>
<includes>
<include>*.exec</include>
</includes>
</fileSet>
</fileSets>
</configuration>
</plugin>
</plugins>
</reporting>


<url>https://juneau.apache.org/</url>
<!-- Inherited from parent pom
<organization>
<name>The Apache Software Foundation</name>
<url>https://www.apache.org/</url>
</organization>
-->
<inceptionYear>2016</inceptionYear>
<inceptionYear>2019</inceptionYear>

<scm>
<connection>scm:git:https://gitbox.apache.org/repos/asf/juneau.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/juneau.git</developerConnection>
<url>https://github.com/apache/juneau</url>
<connection>scm:git:https://gitbox.apache.org/repos/asf/juneau-petstore.git</connection>
<developerConnection>scm:git:https://gitbox.apache.org/repos/asf/juneau-petstore.git</developerConnection>
<url>https://github.com/apache/juneau-petstore</url>
<tag>HEAD</tag>
</scm>
<issueManagement>
Expand Down

0 comments on commit ec767d9

Please sign in to comment.