Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

More markdown

  • Loading branch information...
commit fcc1b4f23dc4dd1d6fb2fe1486b3ea785a140d92 1 parent 595203c
Brad Folkens authored

Showing 1 changed file with 14 additions and 5 deletions. Show diff stats Hide diff stats

  1. +14 5 README.md
19 README.md
Source Rendered
... ... @@ -1,4 +1,5 @@
1   -== Overview
  1 +## Overview
  2 +
2 3 The ModelFormatter module allows you to easily handle fields that need to be formatted or stripped
3 4 of formatting as they are set or retrieved from the database. You can designate one or more of your
4 5 columns as "formatted columns" like in this example:
@@ -34,19 +35,27 @@ columns as "formatted columns" like in this example:
34 35 The methods of this module are automatically included into <tt>ActiveRecord::Base</tt>
35 36 as class methods, so that you can use them in your models.
36 37
37   -== Documentation
  38 +
  39 +## Documentation
  40 +
38 41 For more detailed documentation, create the rdocs with the following command:
39 42
40 43 <tt>rake rdoc</tt>
41 44
42   -== Running Unit Tests
  45 +
  46 +## Running Unit Tests
  47 +
43 48 By default, the ModelFormatter plugin uses the mysql +test+ database, running on +localhost+. To run the tests, enter the following:
44 49
45 50 <tt>rake</tt>
46 51
47   -== Bugs & Feedback
  52 +
  53 +## Bugs & Feedback
  54 +
48 55 Please file a bug report at http://github.com/bfolkens/model-formatter/issues
49 56
50   -== Credits
  57 +
  58 +## Credits
  59 +
51 60 Sebastian Kanthak's file_column plugin - used for ideas and best practices.
52 61

0 comments on commit fcc1b4f

Please sign in to comment.
Something went wrong with that request. Please try again.