README.md

Countastic

🌟 Plain boring numbers in your Pageflow story become animated 🌟

Contains countUp.js version 1.9.3

Installation

Add this line to your application's Gemfile:

gem 'pageflow-countastic'

And then execute:

$ bundle

Configuration

Grab yer ol' text editor and open config/initializers/pageflow.rb:

Pageflow.configure do |config|
  # Lots of other things in this file ...
  config.plugin(Pageflow::Countastic.plugin)

  # Probably lots of other things trailing as well ...
end

Add it to the asset pipeline:

// in app/assets/javascripts/pageflow/application.js:

//= require pageflow/countastic

/* in app/assets/stylesheets/pageflow/application.scss: */

@import "pageflow/countastic";

/* or, if baby Jesus forbid, you're still using Sprockets */
/* in app/assets/stylesheets/application.css: */

/*
*= require pageflow/countastic
*/

/* also, get yourself checked for doing such a thing. */

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/scrollytelling/pageflow-countastic.