diff --git a/README.md b/README.md index 9a6c045..19a1302 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,35 @@ # [showcase](https://vllur.github.io/showcase/) [![Build Status](https://travis-ci.org/vllur/showcase.svg?branch=master)](https://travis-ci.org/vllur/showcase) -Simple portfolio-showcase Jekyll theme. +`showcase` is a modern website for presenting your projects. -See [Gemfile](./Gemfile) and [_config.yml](./_config.yml) for list of all used gems & Jekyll plugins. +![Desktop](assets/img/1.png) -### Font license info: -#### Font Awesome - Copyright (C) 2016 by Dave Gandy +A live demo is available [here](https://vllur.github.io/showcase/). - Author: Dave Gandy - License: SIL () - Homepage: http://fortawesome.github.com/Font-Awesome/ +## Features: +- no dependencies +- can be hosted easily on [Github Pages](https://pages.github.com/) +- modern +- responsive +- simplistic +- really fast (100 points on PageSpeed Insights!) + +## How to: +- do easy deploy: + 1. Fork this repo + 1. Change `baseurl` in `_config.yml` to `/` + 1. Change its name to [nickname].github.io + 1. Visit [nickname].github.io +- customize your projects: + - These are simple list items in `index.html` file - you can add, remove, and edit them there +- customize colours and gradients: + - All of the colours are in `_sass/variables.scss` file. Editing them will edit colours site-wide. + +## Licensing: +### Project +This project is licensed under the MIT license. + +### Font Awesome + Copyright (C) 2016 by Dave Gandy, SIL license + + [fortawesome.com](http://fortawesome.github.com/Font-Awesome/) diff --git a/assets/img/1.png b/assets/img/1.png new file mode 100644 index 0000000..f531dc6 Binary files /dev/null and b/assets/img/1.png differ diff --git a/index.html b/index.html index 502d16f..94c21d6 100644 --- a/index.html +++ b/index.html @@ -7,7 +7,7 @@