From 9e608bd807f1de54ce2f5f6ab64258319a8dc3b0 Mon Sep 17 00:00:00 2001 From: rzen Date: Mon, 31 Aug 2020 21:04:18 -0400 Subject: [PATCH] update readme --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f9dedd..1988111 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # jekyll-theme-isabelline -README is being worked on in [a post](/README/) \ No newline at end of file +Simple clean mobile-friendly theme for long form note taking. Works for blogging too. + +## Features: + +* Compatible with Jekyll 4 +* Designed for long form writing +* Reserved, classy, easy to read, minimalistic visual design +* Semantic lightweight mobile first markup; special attention to markup of block quotes, asides, images, image galleries +* Customizable color scheme + +## Installation + +Add this line to site's `Gemfile`: + +```ruby +gem "jekyll-theme-isabelline", "~> 0.1.0" +``` +And add this line to your Jekyll site: + +```yaml +theme: jekyll-theme-isabelline +``` + +And then execute: + +```sh + $ bundle +``` + +Or, install from CLI: + +```sh + $ gem install jekyll-theme-isabelline +``` \ No newline at end of file