diff --git a/README.md b/README.md index ea2ce50..44383af 100644 --- a/README.md +++ b/README.md @@ -1 +1,30 @@ # Jekyll Theme Dark Reader + +>A Minimal Dark theme for jekyll with minimal CSS + +[Live Demo](https://sharadcodes.github.io/jekyll-theme-dark-reader/) + +## How to install + +1. Download or clone the repo + `git clone https://github.com/sharadcodes/jekyll-theme-dark-reader.git` +2. Enter the folder + `cd jekyll-theme-dark-reader` +3. Run + `bundle install` +4. Start Jekyll server + `bundle exec jekyll serve` +5. Access via + * localhost or according to your pc configurations. +6. Change the `_config.yml` file according to you. +7. Upload the files on your repository and :sunglasses: enjoy. + + +# Screenshots + +## BLOG PAGE +![Blog page](https://github.com/sharadcodes/jekyll-theme-dark-reader/raw/master/screenshots/1.png) +## POST EXAMPLE +![Post page](https://github.com/sharadcodes/jekyll-theme-dark-reader/raw/master/screenshots/2.png) +## PAGE EXAMPLE +![Sampe post](https://github.com/sharadcodes/jekyll-theme-dark-reader/raw/master/screenshots/3.png)