README.md in calrom-0.1.0 vs README.md in calrom-0.2.0
- old
+ new
@@ -1,20 +1,75 @@
# calrom
+[](https://travis-ci.org/calendarium-romanum/calrom)
+[](https://badge.fury.io/rb/calrom)
+
Command line utility providing access to the Roman Catholic
liturgical calendar (post-Vatican II).
Built on top of the [calendarium-romanum][caro] Ruby gem.
## Installation
calrom is a Ruby gem:
-`gem install calrom`
+`$ gem install calrom`
+## Usage
+
+### Specifying date range
+
+Print liturgical calendar for the current month (default):
+
+`$ calrom`
+
+... for a specified month of the current year:
+
+`$ calrom -m 9`
+
+... for a specified month of another year:
+
+`$ calrom -m 1 2028` or `$ calrom 1 2028`
+
+... for a whole year:
+
+`$ calrom 2017`
+
+... for the current year:
+
+`$ calrom -y`
+
+... for a specified date:
+
+`$ calrom 2028-01-15`
+
+... for an arbitrary date range:
+
+`$ calrom 2028-01-15 2028-03-07`
+
+### Data presentation settings
+
+Print detailed listing:
+
+`$ calrom -l`
+
+Disable colours:
+
+`$ calrom --no-color`
+
+## Running tests
+
+Clone the repository, `$ bundle install` to install dependencies, then:
+
+`$ rake cucumber` - run specs describing the command line interface
+
+`$ rake spec` - run specs describing internal implementation details
+
+`$ rake` - run all groups of specs one after another
+
## Project roadmap
-* [ ] detailed listing of a day/month/year/range of dates
+* [x] detailed listing of a day/month/year/range of dates
* [ ] month/year overview - options and output mostly mimicking the
the BSD Unix [`cal`][cal] utility,
but with liturgical colours and celebration ranks
* [ ] condensed format (but with detailed information) suitable for awesome/i3 toolbars etc.
* [ ] machine-readable detailed listing