Commit e32aae62 by Daniel Evans

Update README to reflect serializer updates

parent 504c2674
...@@ -86,13 +86,13 @@ To annotate just your models, tests, and factories: ...@@ -86,13 +86,13 @@ To annotate just your models, tests, and factories:
To annotate just your models: To annotate just your models:
annotate --exclude tests,fixtures,factories annotate --exclude tests,fixtures,factories,serializers
To annotate routes.rb: To annotate routes.rb:
annotate --routes annotate --routes
To remove model/test/fixture/factory annotations: To remove model/test/fixture/factory/serializer annotations:
annotate --delete annotate --delete
...@@ -165,6 +165,8 @@ you can do so with a simple environment variable, instead of editing the ...@@ -165,6 +165,8 @@ you can do so with a simple environment variable, instead of editing the
Place the annotations at the top (before) or the bottom (after) of any test files Place the annotations at the top (before) or the bottom (after) of any test files
--pr, --position-in-routes [before|after] --pr, --position-in-routes [before|after]
Place the annotations at the top (before) or the bottom (after) of the routes.rb file Place the annotations at the top (before) or the bottom (after) of the routes.rb file
--ps, --position-in-serializer [before|after]
Place the annotations at the top (before) or the bottom (after) of the serializer files
-r, --routes Annotate routes.rb with the output of 'rake routes' -r, --routes Annotate routes.rb with the output of 'rake routes'
-v, --version Show the current version of this gem -v, --version Show the current version of this gem
-m, --show-migration Include the migration version number in the annotation -m, --show-migration Include the migration version number in the annotation
...@@ -174,13 +176,15 @@ you can do so with a simple environment variable, instead of editing the ...@@ -174,13 +176,15 @@ you can do so with a simple environment variable, instead of editing the
--ignore-model-subdirects Ignore subdirectories of the models directory --ignore-model-subdirects Ignore subdirectories of the models directory
--sort Sort columns alphabetically, rather than in creation order --sort Sort columns alphabetically, rather than in creation order
-R, --require path Additional file to require before loading models, may be used multiple times -R, --require path Additional file to require before loading models, may be used multiple times
-e [tests,fixtures,factories], Do not annotate fixtures, test files, and/or factories -e [tests,fixtures,factories,serializers],
--exclude --exclude Do not annotate fixtures, test files, factories, and/or serializers
-f [bare|rdoc|markdown], Render Schema Infomation as plain/RDoc/Markdown -f [bare|rdoc|markdown], Render Schema Infomation as plain/RDoc/Markdown
--format --format
--force Force new annotations even if there are no changes. --force Force new annotations even if there are no changes.
--timestamp Include timestamp in (routes) annotation
--trace If unable to annotate a file, print the full stack trace, not just the exception message. --trace If unable to annotate a file, print the full stack trace, not just the exception message.
--timestamp Include an updated time in routes.rb -I, --ignore-columns REGEX don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`
== Sorting == Sorting
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment