Skip to content

Commit

Permalink
Rewrited README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vllur committed Feb 5, 2020
1 parent 1a6136c commit c88d569
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 10 deletions.
38 changes: 30 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)
Binary file added assets/img/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ <h2>Lorem ipsum</h2>
<ul>
<li>
<a href="/">
<h3>Lorem ipsum </h3>
<h3>Lorem ipsum</h3>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit.</p>
<ol>
<li>Lorem</li>
Expand Down Expand Up @@ -78,4 +78,4 @@ <h3>Lorem ipsum</h3>
</a>
</li>
</ul>
</article>
</article>

0 comments on commit c88d569

Please sign in to comment.