From c45ca329b31349ee931147eaa936908d47d58303 Mon Sep 17 00:00:00 2001 From: Zoran Date: Thu, 19 May 2016 14:26:51 -0700 Subject: [PATCH] update gem install instructions in readme --- README.md | 25 ++++++++++++++++++++++++- gem/README.md | 28 +++++++++++++++------------- 2 files changed, 39 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 65fdbcab..151c2408 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,10 @@ [![npm version badge](https://img.shields.io/npm/v/foundation-emails.svg)](https://www.npmjs.org/package/foundation-emails) [![downloads badge](http://img.shields.io/npm/dm/foundation-emails.svg)](https://www.npmjs.org/package/foundation-emails) +[![Gem Version](https://badge.fury.io/rb/foundation_emails.svg)](https://badge.fury.io/rb/foundation_emails) [![downloads badge](http://img.shields.io/npm/l/foundation-emails.svg)](https://www.npmjs.org/package/foundation-emails) - Foundation for Emails (previously known as Ink) is a framework for creating responsive HTML emails that work in any email client — even Outlook. Our HTML/CSS components have been tested across every major email client to ensure consistency. And with the [Inky](https://github.com/zurb/inky) templating language, writing HTML emails is now even easier. ## Getting Started @@ -24,6 +24,29 @@ Then run `npm start` to run the project. A new browser window will open with a B Run `npm run build` to do a full email inlining process. + +#### Using the Ruby gem + +**foundation_emails** is a gem that enables you to use Foundation for Emails assets within a Rails project. To install in your app: + +1. Add the following line to your Gemfile: + + ```ruby + gem 'foundation_emails' + ``` + +2. Then execute: + + ```bash + bundle install + ``` + +3. Import Foundation for Emails in your `application.scss`: + + ```scss + @import "foundation-emails"; + ``` + ## Documentation **Check out our [Migration Guide](https://github.com/zurb/foundation-emails/blob/master/migration.md) for upgrading an existing template or for more in-depth code examples.** diff --git a/gem/README.md b/gem/README.md index 1354aad7..b1901d7f 100644 --- a/gem/README.md +++ b/gem/README.md @@ -1,28 +1,30 @@ -# Foundation for Emails Gem +# foundation_emails [![Gem Version](https://badge.fury.io/rb/foundation_emails.svg)](https://badge.fury.io/rb/foundation_emails) +**foundation_emails** is a gem that enables you to use Foundation for Emails assets within a Rails project. + Foundation for Emails (previously known as Ink) is a framework for creating responsive HTML emails that work in any email client — even Outlook. Our HTML/CSS components have been tested across every major email client to ensure consistency. ## Installation -Add this line to your application's Gemfile: - -```ruby -gem 'foundation_emails' -``` +1. Add the following line to your Gemfile: -Or install it yourself as: + ```ruby + gem 'foundation_emails' + ``` - $ gem install foundation_emails +2. Then execute: -## Usage + ```bash + bundle install + ``` -To include in your assets, place the following in your desired stylesheets manifest: +3. Import Foundation for Emails in your `application.scss`: -```scss - @import "foundation-emails"; -``` + ```scss + @import "foundation-emails"; + ``` ## License -- 2.47.2