diff --git a/README.md b/README.md index c4cb9c9..f8c49fc 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ -# Just the Docs [![Gem Version](https://badge.fury.io/rb/just-the-docs.svg)](https://badge.fury.io/rb/just-the-docs) [![Build Status](https://travis-ci.com/pmarsceill/just-the-docs.svg?branch=master)](https://travis-ci.com/pmarsceill/just-the-docs) +

+ Gem version Build status +

+

+

+

Just the Docs

+

A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
Easily hosted on GitHub pages with few dependencies.

+


+

-A nice looking, high customizable, responsive Jekyll theme for documentation with built-in search. Easily hosted on GitHub pages. ![jtd](https://user-images.githubusercontent.com/896475/47384541-89053c80-d6d5-11e8-98dc-dba16e192de9.gif) - ## Installation Add this line to your Jekyll site's Gemfile: @@ -42,6 +48,13 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsc - Await code review - Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/). +### Design and development principles of this theme: + +1. As few dependencies as possible +2. No build script needed +3. First class mobile experience +4. Make the content shine + ## Development To set up your environment to develop this theme, run `bundle install`.