<commit_before>= Rails Footnotes

If you are developing in Rails you should know the plugin! It displays
footnotes in your application for easy debugging, such as sessions,
request parameters, cookies, filter chain, routes, queries, etc.

Even more, it contains links to open files directly in your editor including
your backtrace lines.

== Installation

NOTE: Since this branch aims Rails 3 support, if you want to use it with Rails 2.3 you should check this branch:

    https://github.com/josevalim/rails-footnotes/tree/rails2

Install Rails Footnotes is very easy.

=== Rails 3.x

   gem 'rails-footnotes', '>= 3.7', :group => :development

=== Rails 2.x

In RAILS_ROOT/config/environments/development.rb (yes, you want it only in development):

  gem "rails-footnotes", '< 3.7.0', :group => :development

== Configuration

For version greater then 3.7.0

If you want to add alternate logic to enable or disable footnotes,
add something like this to config/initializers/footnotes.rb:

  if defined?(Footnotes) && Rails.env.development?
    Footnotes.run! # first of all<commit_msg>[^] README installation section was updated<commit_after>= Rails Footnotes

If you are developing in Rails you should know the plugin! It displays
footnotes in your application for easy debugging, such as sessions,
request parameters, cookies, filter chain, routes, queries, etc.

Even more, it contains links to open files directly in your editor including
your backtrace lines.

== Installation

NOTE: Since this branch aims Rails 3 support, if you want to use it with Rails 2.3 you should check this branch:

    https://github.com/josevalim/rails-footnotes/tree/rails2

Install Rails Footnotes is very easy.

=== Rails 3.x

   gem 'rails-footnotes', '>= 3.7', :group => :development

After you install RailsFootnotes and add it to your Gemfile, you need to run the generator:

  rails generate rails_footnotese:install

=== Rails 2.x

In RAILS_ROOT/config/environments/development.rb (yes, you want it only in development):

  gem "rails-footnotes", '< 3.7.0', :group => :development

== Configuration

For version greater then 3.7.0

If you want to add alternate logic to enable or disable footnotes,
add something like this to config/initializers/footnotes.rb:

  if defined?(Footnotes) && Rails.env.development?
    Footnotes.run! # first of all
{'fraction_non_alphanumeric': 0.08383233532934131, 'fraction_numerical': 0.011976047904191617, 'mean_word_length': 4.352402745995423, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 9, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6106643', 'n_tokens_mistral': 703, 'n_tokens_neox': 641, 'n_words': 291}