Permalink
Browse files

update README format and add note about gem fork

  • Loading branch information...
1 parent 013aaf0 commit 82e6a9502946778b326e97b9bd1a69f278195a3f @phlipper committed Nov 3, 2011
Showing with 20 additions and 11 deletions.
  1. +20 −11 README.md
View
@@ -1,23 +1,26 @@
-YearAfterYear
-==============
+# YearAfterYear
This plugin allows you to keep your copyright year up-to-date.
-Example
-=======
+## Example
You can render the current year in your ERb views like so:
- <%= current_year -%>
+``` erb
+<%= current_year -%>
+```
-If you want to provide a year range, you can use year_range and provide the
-year that you started.
+If you want to provide a year range, you can use `year_range` and provide the year that you started.
- Example: With the assumption that the current year was 2008
+Example: With the assumption that the current year was 2008
- <%= current_year_range(2005) -%> # => 2005-2008
- <%= current_year_range(2005, '&mdash;') -%> # => 2005&mdash;2008
- <%= current_year_range(2008) -%> # => 2008 (just returns current year)
+``` erb
+<%= current_year_range(2005) -%> # => 2005-2008
+<%= current_year_range(2005, '&mdash;') -%> # => 2005&mdash;2008
+<%= current_year_range(2008) -%> # => 2008 (just returns current year)
+```
+
+## Source
You can access the code here:
@@ -27,4 +30,10 @@ Feature Requests / Bugs
* http://planetargon.lighthouseapp.com/projects/5187-open-source-projects
+### Gem
+
+The original repository at http://github.com/robbyrussell/year_after_year was designed to be a Rails plugin. The plugin system has largely been deprecated in favor of using gems, so the fork at http://github.com/phlipper/year_after_year has been updated to build the plugin as a gem instead.
+
+## Copyright
+
Copyright (c) 2008 Robby Russell, released under the MIT license

0 comments on commit 82e6a95

Please sign in to comment.