From 035032857ee6140c3190d3b03174f9d53719a385 Mon Sep 17 00:00:00 2001 From: Stuart Date: Thu, 16 Sep 2021 20:54:29 -0400 Subject: [PATCH] Update readme in prep for v1 release --- readme.md | 22 ++++++---------------- 1 file changed, 6 insertions(+), 16 deletions(-) diff --git a/readme.md b/readme.md index 8192d924..bb420594 100644 --- a/readme.md +++ b/readme.md @@ -17,29 +17,19 @@ [![Gem](https://img.shields.io/gem/v/bootstrap-email.svg)](https://rubygems.org/gems/bootstrap-email) [![Gem](https://img.shields.io/gem/dt/bootstrap-email.svg)](https://rubygems.org/gems/bootstrap-email) -The goal of this project is to build a library similar to [Bootstrap](https://getbootstrap.com) but for HTML emails. Working with HTML in emails is never easy because of the nuances of email vs the web. With Bootstrap Email you don't have to understand all the nuance and it allows you to write emails like you would a website. +Bootstrap Email takes most of it’s inspiration from these two wonderful frameworks, [Bootstrap](https://getbootstrap.com) and [Tailwind](https://tailwindcss.com) but for HTML emails. Working with HTML in emails is never easy because of the nuances of email vs the web. With Bootstrap Email you don't have to understand all the nuance and it allows you to write emails like you would a website. ## Setup There are a few different ways you can use Bootstrap Email to compile emails: -- [Command Line](https://v1.bootstrapemail.com/docs/setup#command-line) -- [Ruby](https://v1.bootstrapemail.com/docs/setup#ruby) -- [Ruby on Rails](https://v1.bootstrapemail.com/docs/setup#ruby-on-rails) -- [Online Editor](https://editor.bootstrapemail.com) +- [Command Line](https://bootstrapemail.com/docs/usage#command-line) +- [Ruby](https://bootstrapemail.com/docs/usage#ruby) +- [Ruby on Rails](https://bootstrapemail.com/docs/usage#ruby-on-rails) +- [Online Editor](https://app.bootstrapemail.com/editor) ## Documentations -For full documentation, visit [bootstrapemail.com](https://v1.bootstrapemail.com/docs/introduction) +For full documentation, visit [bootstrapemail.com](https://bootstrapemail.com/docs/introduction) ## Community For help, discussion about best practices, or any other conversation that would benefit from being searchable: [Discuss Bootstrap Email on GitHub](https://github.com/bootstrap-email/bootstrap-email/discussions) - -