<commit_before>= Guard::Annotate

Annotate guard runs the annotate gem when needed

- Compatible with Annotate 2.4.x
- Tested on Ruby 1.8.7 & 1.9.2

== Install

Install the gem:

    gem install guard-annotate

Add the gem to your Gemfile:
    gem 'guard-annotate'

Add guard definitions to your Guardfile by running:

    guard init annotate


== Usage

Please read the {Guard usage docs}[https://github.com/guard/guard#readme]

== Guardfile

=== Standard Ruby on Rails project

    guard 'annotate' do
      watch('app/models/**.rb')
    end


== Options

You can disable desktop notifications with (default is notifications are enabled):

    guard 'annotate', :notify => false do
      ...
    end

You can customize the placement of the annotations with (default is 'before'):

    guard 'annotate', :position => 'before|after' do
      ...
    end

== Development

- Source hosed at {GitHub}[https://github.com/cpjolicoeur/guard-annotate]
- Issue/Bug/Question/Feature requests via {GitHub Issues}[http://github.com/cpjolicoeur/guard-annotate/issues]

== Authors

{<NAME>}[https://github.com/cpjolicoeur]
<commit_msg>update docs<commit_after>= Guard::Annotate

Annotate guard runs the annotate gem when needed

- Compatible with Annotate 2.4.x
- Tested on Ruby 1.8.7 & 1.9.2

== Install

Install the gem:

    gem install guard-annotate

Add the gem to your Gemfile:
    gem 'guard-annotate'

Add guard definitions to your Guardfile by running:

    guard init annotate


== Usage

Please read the {Guard usage docs}[https://github.com/guard/guard#readme]

== Guardfile

=== Standard Ruby on Rails project

    guard 'annotate' do
      watch( 'db/schema.rb' )
      # Uncomment the following line if you also want to run annotate anytime
      # a model file changes
      #watch( 'app/models/**/*.rb' )
    end
    

== Options

You can disable desktop notifications with (default is notifications are enabled):

    guard 'annotate', :notify => false do
      ...
    end

You can customize the placement of the annotations with (default is 'before'):

    guard 'annotate', :position => 'before|after' do
      ...
    end

== Development

- Source hosed at {GitHub}[https://github.com/cpjolicoeur/guard-annotate]
- Issue/Bug/Question/Feature requests via {GitHub Issues}[http://github.com/cpjolicoeur/guard-annotate/issues]

== Authors

{<NAME>}[https://github.com/cpjolicoeur]

{'fraction_non_alphanumeric': 0.1109715242881072, 'fraction_numerical': 0.006700167504187605, 'mean_word_length': 3.3278985507246377, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 9, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1138298', 'n_tokens_mistral': 775, 'n_tokens_neox': 725, 'n_words': 242}