Contents

# Soonish

Soonish is the quick and easy way to get a beautiful coming soon page up and running for your next Ruby on Rails application.

## Installing

Include the gem in your Gemfile.

    gem 'soonish'

Run `bundle install` to install the gem.

Run the install script to copy over the views and migrations for the engine.

    rails generate soonish:install

## Customising

By default Soonish will be mounted to the root of your application. You can change the URL where the page will be shown by modifying your routes. If you wanted your coming soon page to be displayed at `/soon` you would change your routes to the following.

    mount Soonish::Engine, at: '/soon'

If you only want the coming soon page displayed for a specific environment you can do the follow in your `routes.rb` file.

    if Rails.env == 'production'
      mount Soonish::Engine, at: '/'
    else
      root :to => 'welcome#index'
    end

You can modify the content of the pages by editing the following files

- `app/views/layouts/soonish/soonish.html.erb`: They layout file used for the page
- `app/views/soonish/subscriptions`: This directory holds the views and partials for the page

## Uninstalling

To turn off your coming soon page just comment out or delete the line in your `routes.rb` which is mounting the Soonish engine.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
soonish-0.0.1	README.md