README.md in balboa-0.1.5 vs README.md in balboa-0.1.6
- old
+ new
@@ -1,41 +1,67 @@
# Balboa
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/balboa`. To experiment with that code, run `bin/console` for an interactive prompt.
+[](https://badge.fury.io/rb/balboa)
-TODO: Delete this and the text above, and describe your gem
-
## Installation
-Add this line to your application's Gemfile:
+ $ gem install balboa
-```ruby
-gem 'balboa'
-```
+## Usage
-And then execute:
+A good way to start is:
- $ bundle
+ $ balboa -h
-Or install it yourself as:
+Let's suppose you just want to punch (it will punch from the day after the last punch until it can not punch anymore):
- $ gem install balboa
+ $ balboa punch
+
+Let's suppose you want to skip 11/11/2011, 12/12/2012 and 13/12/2012 (it will skip weekends and ask for punch on holidays):
-## Usage
+ $ balboa punch -s '11/11/2011,12/12/2012,13/12/2012'
+
+Let's suppose you will work for sometime in another project:
-TODO: Write usage instructions here
+ $ balboa punch -w 'Another Project'
+
+Let's suppose you did not input your password (or changed it after setting balboa up) on the first run. You can either:
-## Development
+ $ balboa reset # Or
+ $ balboa punch -p 'New Password'
+
+Let's suppose you don't have phantomjs on your machine. Balboa doesn't care, it will install it for you. Just punch normally.
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+ $ balboa punch
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Let's suppose you don't understand what those `|number|` means. It is the calculated default schedule. Just press enter and Balboa will fill it up for you.
+```
+First shift: |8|
+
+Lunch: |12|
+
+Second shift: |13|
+
+Leave: |18|
+```
+
+Let's suppose your schedule is different from the default. Balboa will help you out.
+
+```
+First shift: |8| 10
+
+Lunch: |14| 15
+
+Second shift: |16|
+
+Leave: |19|
+```
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/balboa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-