From 02b22cafffb8c3436ab4c6b1f9039cf297a7db47 Mon Sep 17 00:00:00 2001 From: Matt Brictson Date: Fri, 5 Jan 2018 21:07:54 -0800 Subject: [PATCH] Explain new Ruby, Rails, Bootstrap requirements The master branch is now targeting Bootstrap v4, Rails 5+, and Ruby 2.3+. Make it clear that the master branch is not yet stable, and refer people to the `legacy-2.7` branch for Bootstrap v3 support. [skip ci] --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0e1226246..4015e104c 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,30 @@ -[![Build Status](https://travis-ci.org/bootstrap-ruby/rails-bootstrap-forms.svg?branch=master)](https://travis-ci.org/bootstrap-ruby/rails-bootstrap-forms) -[![Gem Version](https://badge.fury.io/rb/bootstrap_form.svg)](http://badge.fury.io/rb/bootstrap_form) +⚠️ **This documentation is for the master branch, which is not yet stable and targets Bootstrap v4.** If you are using Bootstrap v3, refer to the stable [legacy-2.7](https://github.com/bootstrap-ruby/rails-bootstrap-forms/tree/legacy-2.7) branch. + +--- -# Rails Bootstrap Forms +# bootstrap_form -**Rails Bootstrap Forms** is a rails form builder that makes it super easy to integrate -twitter bootstrap-style forms into your rails application. +[![Build Status](https://travis-ci.org/bootstrap-ruby/rails-bootstrap-forms.svg?branch=master)](https://travis-ci.org/bootstrap-ruby/rails-bootstrap-forms) +[![Gem Version](https://badge.fury.io/rb/bootstrap_form.svg)](https://rubygems.org/gems/bootstrap_form) + +**bootstrap_form** is a Rails form builder that makes it super easy to integrate +Bootstrap v4-style forms into your Rails application. ## Requirements -* Ruby 1.9+ -* Rails 4.0+ -* Twitter Bootstrap 3.0+ +* Ruby 2.3+ +* Rails 5.0+ +* Bootstrap 4.0.0-beta.3+ ## Installation Add it to your Gemfile: -`gem 'bootstrap_form'` +```ruby +gem "bootstrap_form", + git: "https://github.com/bootstrap-ruby/rails-bootstrap-forms.git", + branch: "master" +``` Then: @@ -589,4 +597,4 @@ document first. ## License -MIT License. Copyright 2012-2014 Stephen Potenza (https://github.com/potenza) +MIT License. Copyright 2012-2018 Stephen Potenza (https://github.com/potenza)