Permalink
Browse files

Update Gems and documentation

  • Loading branch information...
1 parent adfba4d commit 8f4986d809775922942c92941efbb01c35badfff @psgs psgs committed Dec 21, 2016
Showing with 8 additions and 8 deletions.
  1. +2 −5 Gemfile
  2. +6 −3 README.md
View
@@ -1,10 +1,7 @@
source 'https://rubygems.org'
-# Freeze to GitHub Pages versions:
-# https://pages.github.com/versions/
-gem 'github-pages', '~> 75'
-gem 'jekyll', '~> 3.0.4'
-gem 'kramdown', '~> 1.10.0'
+# Dependencies are bundled with the github-pages gem
+gem 'github-pages', '112', group: :jekyll_plugins
group :test do
gem 'fastimage'
View
@@ -23,16 +23,19 @@ If you'd like to contribute, read the entire guidelines here in
## Running Locally
-TwoFactorAuth.org is built on [Jekyll](https://jekyllrb.com/). In order to run Jekyll, it is necessary to install Ruby with RubyGems.
+TwoFactorAuth.org is built upon [Jekyll](https://jekyllrb.com/), using the [github-pages](https://github.com/github/pages-gem) gem.
+In order to run the site locally, it is necessary to install bundler, install all dependencies, and then use Jekyll to serve
+the site. If the `gem` command is not available to you, it is necessary to install Ruby with RubyGems.
Once Ruby and RubyGems are installed and available from the command line, TwoFactorAuth can be setup using the following commands.
```
-gem install jekyll
+gem install bundler
cd ~/twofactorauth
+bundle install
jekyll serve
```
-The TwoFactorAuth website should then be running on `http://localhost:4000`.
+The TwoFactorAuth website should then be accessible from `http://localhost:4000`.
## License

0 comments on commit 8f4986d

Please sign in to comment.