Skip to content

Commit

Permalink
README, yes we have
Browse files Browse the repository at this point in the history
  • Loading branch information
peleteiro committed Sep 16, 2010
1 parent 5fac015 commit f4fbad6
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 21 deletions.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,4 +1,4 @@
Copyright (c) 2009 Jose Peleteiro
Copyright (c) 2010 Jose Peleteiro

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand Down
63 changes: 63 additions & 0 deletions README.md
@@ -0,0 +1,63 @@
ruby-duration
=============

Duration is an immutable type that represents some amount of time with accuracy in seconds.


Features
--------

* Representation of time in weeks, days, hours, minutes and seconds.
* Construtor can receive the amount of time in seconds or a Hash with unit and amount of time.
* Format method to display the time with i18n support.
* Mongoid serialization support. Use `require 'duration/mongoid'`.


Show me the code
----------------

### construct

Duration.new(100) => #<Duration: minutes=1, seconds=40, total=100>
Duration.new(:hours => 5, :minutes => 70) => #<Duration: hours=6, minutes=10, total=22200>


### format

Duration.new(:weeks => 3, :days => 1).format("%w %~w and %d %~d") => "3 weeks and 1 day"
Duration.new(:weeks => 1, :days => 20).format("%w %~w and %d %~d") => "1 week and 20 days"


Note on Patches/Pull Requests
-----------------------------

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.

License
---------
Copyright (c) 2010 Jose Peleteiro

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
17 changes: 0 additions & 17 deletions README.rdoc

This file was deleted.

5 changes: 2 additions & 3 deletions ruby-duration.gemspec
Expand Up @@ -9,17 +9,16 @@ Gem::Specification.new do |s|

s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
s.authors = ["Jose Peleteiro"]
s.date = %q{2010-09-15}
s.date = %q{2010-09-16}
s.description = %q{Duration type}
s.email = %q{jose@peleteiro.net}
s.extra_rdoc_files = [
"LICENSE",
"README.rdoc"
"README.md"
]
s.files = [
".gitignore",
"LICENSE",
"README.rdoc",
"Rakefile",
"VERSION",
"lib/duration.rb",
Expand Down

0 comments on commit f4fbad6

Please sign in to comment.