README.md in alembic-jekyll-theme-2.2.4 vs README.md in alembic-jekyll-theme-2.2.5
- old
+ new
@@ -3,10 +3,12 @@
⚗ A Jekyll boilerplate theme designed to be a starting point for any Jekyll website.

+[Tweet it](https://twitter.com/intent/tweet/?url=https://alembic.darn.es&text=Alembic%20-%20A%20Jekyll%20boilerplate%20theme&via=DavidDarnes) | [Tip me $5 💸](https://www.paypal.me/daviddarnes/5usd)
+
## Contents
- [About](#about)
- [Features](#features)
- [Examples](#examples)
- [Installation](#installation)
@@ -58,27 +60,28 @@
## Installation
### As a Boilerplate / Fork
1. [Fork the repo](https://github.com/daviddarnes/alembic#fork-destination-box)
-2. Clone down the repo with `$ git clone git@github.com:username/reponame.git`
-3. Delete the following unnecessary files/folders: `demo/`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE`, `screenshot.png` and `alembic-jekyll-theme.gemspec`
-4. Change the `logo.svg` and `default-social-image.png` in the `assets/` folder to your own branding
-5. Configure your site settings using the `_config.yml`, more info can be found in [Configuration](#configuration)
-5. Change the `CNAME` record to your projects' record
-6. Install bundler with `$ gem install bundler`
-7. Install gems with `$ bundle install`
-8. Run Jekyll with `$ bundle exec jekyll serve --watch`
-9. Begin hacking for your project
+2. Clone down the repo with `git clone git@github.com:username/reponame.git`
+3. Replace the `Gemfile` in the root of the repo with the one in `demo/Gemfile`
+4. Delete the following unnecessary files/folders: `demo/`, `CODE_OF_CONDUCT.md`, `CONTRIBUTING.md`, `LICENSE`, `screenshot.png` and `alembic-jekyll-theme.gemspec`
+5. Change the `logo.svg` and `default-social-image.png` in the `assets/` folder to your own branding
+6. Configure your site settings using the `_config.yml`, more info can be found in [Configuration](#configuration)
+7. Change the `CNAME` record to your projects' record
+8. Install bundler with `gem install bundler`
+9. Install gems with `bundle install`
+10. Run Jekyll with `bundle exec jekyll serve --watch`
+11. Begin hacking for your project
### As a Jekyll 3.3 theme gem
1. Download the starter `/demo` content, [quick download link](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/daviddarnes/alembic/tree/master/demo)
2. Configure your site settings using the `_config.yml`, more info can be found in [Configuration](#configuration)
3. Create a `logo.svg` and `default-social-image.png` in a new `assets/` folder
-4. Install bundler with `$ gem install bundler`
-5. Install gems with `$ bundle install`
-6. Run Jekyll with `$ bundle exec jekyll serve --watch`
+4. Install bundler with `gem install bundler`
+5. Install gems with `bundle install`
+6. Run Jekyll with `bundle exec jekyll serve --watch`
7. Begin hacking for your project
### Boilerplate & Theme differences
The boilerplate kit is better for more drastic hacking and changes, a project that's quite different to any other and needs a lot of custom work done. Additionally you'll only be able to use this method if you want to host it on GitHub Pages, as [themes can't be submitted](https://pages.github.com/themes/)... yet.