summaryrefslogtreecommitdiff
path: root/src/Propellor.hs
diff options
context:
space:
mode:
Diffstat (limited to 'src/Propellor.hs')
-rw-r--r--src/Propellor.hs9
1 files changed, 5 insertions, 4 deletions
diff --git a/src/Propellor.hs b/src/Propellor.hs
index 9c5a85a9..a371ea44 100644
--- a/src/Propellor.hs
+++ b/src/Propellor.hs
@@ -14,13 +14,14 @@
-- > main = defaultMain hosts
-- >
-- > hosts :: [Host]
--- > hosts =
--- > [ host "example.com"
+-- > hosts = [example]
+-- >
+-- > example :: Host
+-- > example = host "example.com" $ props
-- > & Apt.installed ["mydaemon"]
-- > & "/etc/mydaemon.conf" `File.containsLine` "secure=1"
-- > `onChange` cmdProperty "service" ["mydaemon", "restart"]
-- > ! Apt.installed ["unwantedpackage"]
--- > ]
--
-- See config.hs for a more complete example, and clone Propellor's
-- git repository for a deployable system using Propellor:
@@ -38,7 +39,6 @@ module Propellor (
, (&)
, (!)
-- * Propertries
- , describe
-- | Properties are often combined together in your propellor
-- configuration. For example:
--
@@ -47,6 +47,7 @@ module Propellor (
, requires
, before
, onChange
+ , describe
, module Propellor.Property
-- | Everything you need to build your own properties,
-- and useful property combinators