README.md in dockly-1.0.0 vs README.md in dockly-1.1.0
- old
+ new
@@ -5,16 +5,20 @@
Dockly
=======
`dockly` is a gem made to ease the pain of packaging an application. For this gem to be useful, quite a few assumptions can be made about your stack:
-- You use AWS
- You're deploying to a Debian-based system
- You want to use [Docker](http://docker.io) for process isolation
Although only a specific type of repository may be used, these assumptions allow us to define a simple DSL to describe your repository.
+Usage
+-----
+
+Once a `deb` block has been defined by the DSL below, dockly is invoked by either `bundle exec dockly build #{deb block name}` or `bundle exec rake dockly:deb:#{deb block name}`.
+
The DSL
-------
The DSL is broken down into multiple objects, all of which conform to a specific format. Each object starts with the name of the section,
followed by a name for the object you're creating, and a block for configuration.
@@ -56,10 +60,12 @@
```
`build_cache`
-------------
+Optional
+
The `build_cache` DSL is used to prevent rebuilding assets every build and used cached assets.
- `s3_bucket`
- required: `true`
- description: the bucket name to download and upload build caches to
@@ -134,9 +140,11 @@
Need finer control of Docker packages? We also wrote [docker-api](https://github.com/swipely/docker-api).
`foreman`
---------
+
+Optional
The `foreman` DSL is used to define the foreman export scripts. It has the following attributes:
- `env`
- description: accepts same arguments as `foreman start --env`