Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jjlauer committed Nov 29, 2023
1 parent 614fb55 commit e6b5014
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,6 @@
[![MacOS x64](https://img.shields.io/github/actions/workflow/status/fizzed/stork/macos-x64.yaml?branch=master&label=MacOS%20x64&style=flat-square)](https://github.com/fizzed/stork/actions/workflows/macos-x64.yaml)
[![Windows x64](https://img.shields.io/github/actions/workflow/status/fizzed/stork/windows-x64.yaml?branch=master&label=Windows%20x64&style=flat-square)](https://github.com/fizzed/stork/actions/workflows/windows-x64.yaml)

## Sponsorship & Support

![](https://cdn.fizzed.com/github/fizzed-logo-100.png)

Project by [Fizzed, Inc.](http://fizzed.com) (Follow on Twitter: [@fizzed_inc](http://twitter.com/fizzed_inc))

**Developing and maintaining opensource projects requires significant time.** If you find this project useful or need
commercial support, we'd love to chat. Drop us an email at [ping@fizzed.com](mailto:ping@fizzed.com)

Project sponsors may include the following benefits:

- Priority support (outside of Github)
- Feature development & roadmap
- Priority bug fixes
- Privately hosted continuous integration tests for their unique edge or use cases

## Overview

So you've engineered that amazing Java-based application. Then what? Distributing
Expand All @@ -39,25 +23,41 @@ and securely run your app in any environment -- be it Docker, Rkt, LXD, or
traditional systems. There are 3 main Stork components that you can pick and
choose from to help with your app:

- [stork-launcher](#stork-launcher) will generate well-tested, rock solid, secure
launcher scripts from a yaml configuration file for either console or daemon/service
JVM apps. The generated launchers will run your app the same way regardless of whether
running within a container or numerous different operating systems.
- [stork-launcher](#stork-launcher) will generate well-tested, rock solid, secure
launcher scripts from a yaml configuration file for either console or daemon/service
JVM apps. The generated launchers will run your app the same way regardless of whether
running within a container or numerous different operating systems.

- [stork-assembly](#stork-assembly) will assemble your JVM app into a standard,
well-defined [canonical layout](docs/CANONICAL_LAYOUT.md) as a tarball ready
for universal distribution or deployment. Regardless of whether your user
is on Linux, Windows, OSX, *BSD, etc., our tarball will include everything
for your user to be happy.
- [stork-assembly](#stork-assembly) will assemble your JVM app into a standard,
well-defined [canonical layout](docs/CANONICAL_LAYOUT.md) as a tarball ready
for universal distribution or deployment. Regardless of whether your user
is on Linux, Windows, OSX, *BSD, etc., our tarball will include everything
for your user to be happy.

- [stork-deploy](#stork-deploy) will rapidly and securely deploy your assembly
via SSH into a versioned directory structure to various operating systems.
It will handle restarting daemons, use strict user/group permissions, and verify
the deploy worked. Power users can combine with [Blaze](https://github.com/fizzed/blaze)
for even more advanced deploys.
- [stork-deploy](#stork-deploy) will rapidly and securely deploy your assembly
via SSH into a versioned directory structure to various operating systems.
It will handle restarting daemons, use strict user/group permissions, and verify
the deploy worked. Power users can combine with [Blaze](https://github.com/fizzed/blaze)
for even more advanced deploys.

[Using Stork to deploy a production Ninja Framework app](http://fizzed.com/blog/2015/01/using-stork-deploy-production-ninja-framework-app)

## Sponsorship & Support

![](https://cdn.fizzed.com/github/fizzed-logo-100.png)

Project by [Fizzed, Inc.](http://fizzed.com) (Follow on Twitter: [@fizzed_inc](http://twitter.com/fizzed_inc))

**Developing and maintaining opensource projects requires significant time.** If you find this project useful or need
commercial support, we'd love to chat. Drop us an email at [ping@fizzed.com](mailto:ping@fizzed.com)

Project sponsors may include the following benefits:

- Priority support (outside of Github)
- Feature development & roadmap
- Priority bug fixes
- Privately hosted continuous integration tests for their unique edge or use cases

## Example

[stork-demo-hellod](stork-demo/stork-demo-hellod) is an example Maven project
Expand Down

0 comments on commit e6b5014

Please sign in to comment.