Skip to content

Commit

Permalink
Add status badges to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aalmiray committed Feb 13, 2021
1 parent 66f0966 commit 2b70de6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven

name: Java CI with Maven
name: Build

on:
push:
Expand Down
31 changes: 19 additions & 12 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
= Layrry - A Launcher and API for Modularized Java Applications
:layrry-version: 1.0.0.Alpha1
:linkattrs:
:project-owner: moditect
:project-name: layrry
:project-group: org.moditect.layrry
:project-version: 1.0.0.Alpha1

_Latest version: {layrry-version} (http://andresalmiray.com/layrry-1-0-0-alpha1-has-been-released/[announcement])_
image:https://github.com/{project-owner}/{project-name}/workflows/Build/badge.svg["Build Status", link="https://github.com/{project-owner}/{project-name}/actions"]
image:https://img.shields.io/maven-central/v/{project-group}/{project-name}-core.svg[Download, link="https://search.maven.org/#search|ga|1|{project-group}"]

_Latest version: {project-version} (http://andresalmiray.com/layrry-1-0-0-alpha1-has-been-released/[announcement])_

Layrry is a launcher and Java API for executing modularized Java applications.

Expand Down Expand Up @@ -53,15 +60,15 @@ The Layrry Launcher is a CLI tool which takes a configuration of a layered appli
[source]
[subs="attributes"]
----
layrry-launcher-{layrry-version}-all.jar --layers-config <path/to/layers.yml> [program arguments]
layrry-launcher-{project-version}-all.jar --layers-config <path/to/layers.yml> [program arguments]
----

E.g. like so:

[source]
[subs="attributes"]
----
layrry-launcher-{layrry-version}-all.jar --layers-config hello-world.yml Alice Bob
layrry-launcher-{project-version}-all.jar --layers-config hello-world.yml Alice Bob
----

The application layers configuration file is a YAML file which the following structure:
Expand Down Expand Up @@ -323,15 +330,15 @@ supported by JavaFX
project_version = 1.0.0
javafx_version = 11.0.2
tilesfx_version = 11.44
layrry_version = {layrry-version}
layrry_version = {project-version}
----

This application can be launched as

[source]
[subs="attributes"]
----
layrry-launcher-{layrry-version}-all.jar --layers-config layers.toml --properties versions.properties
layrry-launcher-{project-version}-all.jar --layers-config layers.toml --properties versions.properties
----

== Remote Configuration
Expand All @@ -343,7 +350,7 @@ that exposes those resources via HTTPS, such as
[source]
[subs="attributes"]
----
layrry-launcher-{layrry-version}-all.jar \
layrry-launcher-{project-version}-all.jar \
--basedir /home/user/joe \
--layers-config https://server:port/path/to/layers.toml \
--properties https://server:port/path/to/versions.properties
Expand All @@ -360,7 +367,7 @@ resources as you deem necessary, that is, the following combinations are valid:
[subs="attributes"]
.All remote
----
layrry-launcher-{layrry-version}-all.jar \
layrry-launcher-{project-version}-all.jar \
--basedir /home/user/joe \
--layers-config https://server:port/path/to/layers.toml \
--properties https://server:port/path/to/versions.properties
Expand All @@ -370,7 +377,7 @@ layrry-launcher-{layrry-version}-all.jar \
[subs="attributes"]
.All local
----
layrry-launcher-{layrry-version}-all.jar \
layrry-launcher-{project-version}-all.jar \
--basedir /home/user/joe \
--layers-config layers.toml \
--properties versions.properties
Expand All @@ -380,7 +387,7 @@ layrry-launcher-{layrry-version}-all.jar \
[subs="attributes"]
.Mixed
----
layrry-launcher-{layrry-version}-all.jar \
layrry-launcher-{project-version}-all.jar \
--basedir /home/user/joe \
--layers-config https://server:port/path/to/layers.toml \
--properties versions.properties
Expand All @@ -389,7 +396,7 @@ layrry-launcher-{layrry-version}-all.jar \
[source]
[subs="attributes"]
----
layrry-launcher-{layrry-version}-all.jar \
layrry-launcher-{project-version}-all.jar \
--basedir /home/user/joe \
--layers-config layers.toml \
--properties https://server:port/path/to/versions.properties
Expand Down Expand Up @@ -438,7 +445,7 @@ In order to use Layrry programmatically, add the following dependency to your _p
<dependency>
<groupId>org.moditect.layrry</groupId>
<artifactId>layrry</artifactId>
<version>{layrry-version}</version>
<version>{project-version}</version>
</dependency>
----

Expand Down

0 comments on commit 2b70de6

Please sign in to comment.