updated readme

This commit is contained in:
2010-07-27 20:16:55 +03:00
parent b90c73c9d3
commit 88ece14760
6 changed files with 17 additions and 15 deletions

View File

@@ -15,11 +15,11 @@ This gem extends the abilities of Ruby's built-in Time class by building on top
#=> Beginning of this week, or next week depending on which date is closest
## Notable Methods
## Documentation
The `round`, `floor`, and `ceil` methods were the main reason I created this gem. Each of them takes a unit argument, which can be one of the following: `:sec`, `:min`, `:hour`, `:day`, `:week`, `:month`, `:quarter`, and `:year`.
A decently informative documentation is available [here][docs] on [rdoc.info][].
For more, please refer to the source code or the spec tests for now.
The main reason I created this gem was for the `round`, `floor`, and `ceil` methods. Each of them takes a unit argument, which can be one of the following: `:sec`, `:min`, `:hour`, `:day`, `:week`, `:month`, `:quarter`, and `:year`.
## To-Do
@@ -64,4 +64,6 @@ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[as]: http://as.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Time/Calculations.html
[as]: http://as.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Time/Calculations.html
[docs]: http://rdoc.info/projects/jimeh/time_ext
[rdoc.info]: http://rdoc.info/

View File

@@ -2268,7 +2268,7 @@ future.
</div>
<div id="footer">
Generated on Tue Jul 27 20:08:52 2010 by
Generated on Tue Jul 27 20:16:37 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 (ruby-1.8.7).
</div>

View File

@@ -85,7 +85,7 @@
</div></div>
<div id="footer">
Generated on Tue Jul 27 20:08:51 2010 by
Generated on Tue Jul 27 20:16:35 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 (ruby-1.8.7).
</div>

View File

@@ -57,11 +57,11 @@
<span class='comment val'>#=&gt; Beginning of this week, or next week depending on which date is closest</span>
</pre>
<h2 id='notable_methods'>Notable Methods</h2>
<h2 id='documentation'>Documentation</h2>
<p>The <code>round</code>, <code>floor</code>, and <code>ceil</code> methods were the main reason I created this gem. Each of them takes a unit argument, which can be one of the following: <code>:sec</code>, <code>:min</code>, <code>:hour</code>, <code>:day</code>, <code>:week</code>, <code>:month</code>, <code>:quarter</code>, and <code>:year</code>.</p>
<p>A decently informative documentation is available <a href='http://rdoc.info/projects/jimeh/time_ext'>here</a> on <a href='http://rdoc.info/'>rdoc.info</a>.</p>
<p>For more, please refer to the source code or the spec tests for now.</p>
<p>The main reason I created this gem was for the <code>round</code>, <code>floor</code>, and <code>ceil</code> methods. Each of them takes a unit argument, which can be one of the following: <code>:sec</code>, <code>:min</code>, <code>:hour</code>, <code>:day</code>, <code>:week</code>, <code>:month</code>, <code>:quarter</code>, and <code>:year</code>.</p>
<h2 id='todo'>To-Do</h2>
@@ -96,7 +96,7 @@
<p>THE SOFTWARE IS PROVIDED &#8220;AS IS&#8221;, 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.</p></div></div>
<div id="footer">
Generated on Tue Jul 27 20:08:51 2010 by
Generated on Tue Jul 27 20:16:35 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 (ruby-1.8.7).
</div>

View File

@@ -57,11 +57,11 @@
<span class='comment val'>#=&gt; Beginning of this week, or next week depending on which date is closest</span>
</pre>
<h2 id='notable_methods'>Notable Methods</h2>
<h2 id='documentation'>Documentation</h2>
<p>The <code>round</code>, <code>floor</code>, and <code>ceil</code> methods were the main reason I created this gem. Each of them takes a unit argument, which can be one of the following: <code>:sec</code>, <code>:min</code>, <code>:hour</code>, <code>:day</code>, <code>:week</code>, <code>:month</code>, <code>:quarter</code>, and <code>:year</code>.</p>
<p>A decently informative documentation is available <a href='http://rdoc.info/projects/jimeh/time_ext'>here</a> on <a href='http://rdoc.info/'>rdoc.info</a>.</p>
<p>For more, please refer to the source code or the spec tests for now.</p>
<p>The main reason I created this gem was for the <code>round</code>, <code>floor</code>, and <code>ceil</code> methods. Each of them takes a unit argument, which can be one of the following: <code>:sec</code>, <code>:min</code>, <code>:hour</code>, <code>:day</code>, <code>:week</code>, <code>:month</code>, <code>:quarter</code>, and <code>:year</code>.</p>
<h2 id='todo'>To-Do</h2>
@@ -96,7 +96,7 @@
<p>THE SOFTWARE IS PROVIDED &#8220;AS IS&#8221;, 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.</p></div></div>
<div id="footer">
Generated on Tue Jul 27 20:08:51 2010 by
Generated on Tue Jul 27 20:16:35 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 (ruby-1.8.7).
</div>

View File

@@ -79,7 +79,7 @@
</div>
<div id="footer">
Generated on Tue Jul 27 20:08:52 2010 by
Generated on Tue Jul 27 20:16:37 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 (ruby-1.8.7).
</div>