Skip to content
This repository has been archived by the owner on Jun 7, 2021. It is now read-only.

Commit

Permalink
Update root README and links to JIRA.
Browse files Browse the repository at this point in the history
  • Loading branch information
bobmcwhirter committed Dec 14, 2015
1 parent a59df8c commit 221c6d7
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 23 deletions.
71 changes: 71 additions & 0 deletions README.adoc
@@ -0,0 +1,71 @@
= WildFly-Swarm Examples

> Please raise any issues found with this example in this repo:
> https://github.com/wildfly-swarm/wildfly-swarm-examples/issues
>
> Issues related to *WildFly Swarm* core should be raised in our JIRA:
> https://issues.jboss.org/browse/SWARM

== WildFly Swarm

This repository contains examples for the http://wildfly-swarm.io[WildFly Swarm] project.

It is currently listed as *alpha* release software, subject to massive, possibly-breaking,
changes as we determine exactly how it should all hang together.

== These Examples

These examples demonstrate utilizing and combining different different parts of WildFly to create
a self-contained executable jar. They provide small, specific, working examples that can be used
as a reference for your own project.

By default, this repository uses `SNAPSHOT` versions of WildFly Swarm. They are used to test
particular aspects of the WildFly Swarm project in addition to being useful examples of what
you can do and how you can do it.

Since these examples are `SNAPSHOT`-centric, our *snapshot* repository is added to the
root `pom.xml`. If you were to build https://github.com/wildfly-swarm/wildfly-swarm[WildFly Swarm]
directly, that would of course take precedence.

If you want to use our *snapshot* repository in your own projects, include this in your `pom.xml`:

[source,xml]
----
<repositories>
<repository>
<id>projectodd-snapshots</id>
<name>Project:odd Snapshots from CI</name>
<url>https://repository-projectodd.forge.cloudbees.com/snapshot</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>projectodd-snapshots</id>
<name>Project:odd Snapshots from CI</name>
<url>https://repository-projectodd.forge.cloudbees.com/snapshot</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</pluginRepository>
</pluginRepositories>
----

To run the examples for a given release, please clone and checkout the particular Git tag
or https://github.com/wildfly-swarm/wildfly-swarm-examples/releases[download from the releases].

== UberJar vs non

By default, each example runs using the Maven plugin without constructing
an *uberjar*. To run them as an *uberjar*, use the `-Puberjar` profile
when invoking Maven.

mvn install -Puberjar
17 changes: 0 additions & 17 deletions README.md

This file was deleted.

6 changes: 3 additions & 3 deletions datasource/datasource-deployment/README.adoc
@@ -1,10 +1,10 @@
= Datasource via Deployment.

> Please raise any issues found with this example in this repo:
> https://github.com/wildfly-swarm/wildfly-swarm-examples
> https://github.com/wildfly-swarm/wildfly-swarm-examples/issues
>
> Issues related to WildFly Swarm core should be raised in the main repo:
> https://github.com/wildfly-swarm/wildfly-swarm/issues
> Issues related to *WildFly Swarm* core should be raised in our JIRA:
> https://issues.jboss.org/browse/SWARM

This example demonstrates how to deploy a datasource as
a _deployment_.
Expand Down
6 changes: 3 additions & 3 deletions datasource/datasource-subsystem/README.adoc
@@ -1,10 +1,10 @@
= Datasource via Fraction

> Please raise any issues found with this example in this repo:
> https://github.com/wildfly-swarm/wildfly-swarm-examples
> https://github.com/wildfly-swarm/wildfly-swarm-examples/issues
>
> Issues related to WildFly Swarm core should be raised in the main repo:
> https://github.com/wildfly-swarm/wildfly-swarm/issues
> Issues related to *WildFly Swarm* core should be raised in our JIRA:
> https://issues.jboss.org/browse/SWARM

This example demonstrates how to create a datasource through
fraction configuration.
Expand Down

0 comments on commit 221c6d7

Please sign in to comment.