aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/app.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/app.txt b/docs/app.txt
index 487c9cd..9e9afc0 100644
--- a/docs/app.txt
+++ b/docs/app.txt
@@ -25,6 +25,24 @@ $ app upgrade
$ app restart
---------------------------------------------------------------------
+appsh is a pragmatic approach to managing a set of apps on a server.
+It is heavily inspired by git's approach in its command line interface
+and scriptability.
+
+It handles installation aspects: downloading, unpacking and upgrading,
+operational aspects: starting, stopping and basic configuration.
+
+The package contains a set of tools that can be used directly on the
+command line, or through your own extensions.
+
+Requirements
+^^^^^^^^^^^^
+
+* Linux. OSX and Cygwin are possible to support, but it's not tested
+ there yet. Solaris is also doable.
+* Bash 4 and "standard" GNU userland.
+* If using Maven: xmlstarlet
+
INSTALLING AN APPLICATION
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -133,6 +151,9 @@ TODOs
* Find a way to check if an application is running.
+* Make `app.state` a core feature. Possible values are `enabled` and
+ `disabled`.
+
SEE ALSO
--------