README.md in fullcalendar-bootstrap-rails-0.1.0 vs README.md in fullcalendar-bootstrap-rails-2.3.1.0

- old
+ new

@@ -7,13 +7,13 @@ 3. Tried to make it look consistent with the rest of your [Bootstrap][bootstrap]-powered views? Welcome! ## Installation -Add this line to your application's Gemfile: - +Add this gem and its [momentjs][moment] dependency to your application's Gemfile: ```ruby +gem 'momentjs-rails' gem 'fullcalendar-bootstrap-rails' ``` And then execute: @@ -21,19 +21,45 @@ Or install it yourself as: $ gem install fullcalendar-bootstrap-rails +At this point, the files from the FullCalendar project are in your asset +pipeline's path… all you have to do is require them in the appropriate places. + +Here is an example: +* CSS: + ```scss + // app/assets/stylesheets/application.scss + + @import "bootstrap-sprockets"; + @import "bootstrap"; + // after the bootstrap dependency + @import "fullcalendar"; + ``` + +* javascript: + ```js + // app/assets/javascripts/application.js + + //= require bootstrap-sprockets + //= require moment + // after the bootstrap and moment dependencies + //= require fullcalendar + ``` + +For more details and options, check the [fullcalendar-rails installation section][fullcalendar-rails-install]. + ### A note on versioning First noticed this type of versioning with @bokmann's [fullcalendar-rails][fullcalendar-rails]: > I am going to version this gem with the version of the FullCalendar code I use, adding an extra digit if I need to release any maintenance versions of the gem itself. Makes sense to me: It's [Semantic Versioning][semver], just that a different semantic. I'm inheriting it, this way you can explicitly require a specific version of FullCalendar, if available: - gem 'fullcalendar-bootstrap-rails', '~> X.Y.Z.0' + gem 'fullcalendar-bootstrap-rails', '~> 2.3.1.0' where the digit after the [semantical patch version][semver] indicates the release of this gem. ## Usage @@ -57,7 +83,9 @@ 5. Create a new Pull Request [fullcalendar]: http://fullcalendar.io/ [fullcalendar-rails]: https://github.com/bokmann/fullcalendar-rails + [fullcalendar-rails-install]: https://github.com/bokmann/fullcalendar-rails#installation + [moment]: http://momentjs.com/ [bootstrap]: http://getbootstrap.com/ [semver]: http://semver.org/