Updated readme

This commit is contained in:
Panos Sakkos 2016-08-07 19:26:31 +02:00
parent f5b2357f25
commit 9ec7b8bafe
2 changed files with 26 additions and 54 deletions

BIN
.github/personal-mobile.mov.gif vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 MiB

View file

@ -1,12 +1,15 @@
# { Personal } Jekyll Theme
![Build Status](https://travis-ci.org/PanosSakkos/personal-jekyll-theme.svg?branch=master)
![license](https://img.shields.io/badge/license-MIT-blue.svg?link=https://github.com/dono-app/ios/blob/master/LICENSE)
[![Join the chat at https://gitter.im/PanosSakkos/personal-jekyll-theme](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/PanosSakkos/personal-jekyll-theme?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# { Personal } Jekyll Theme
{ Personal } is a free responsive Jekyll theme, about you :wink:
You can watch it in action [here](https://panossakkos.github.io/personal-jekyll-theme/)!
<img src="https://github.com/panossakkos/personal-jekyll-theme/raw/master/.github/personal-mobile.mov.gif" height="480">
## What value does { Personal } add
* Fork of [Timeline](https://github.com/kirbyt/timeline-jekyll-theme) (mashup of [Grayscale by Start Bootstrap](https://github.com/IronSummitMedia/startbootstrap-grayscale) and [Agency Jekyll Theme](https://github.com/y7kim/agency-jekyll-theme))
@ -39,50 +42,10 @@ You can watch it in action [here](https://panossakkos.github.io/personal-jekyll-
* Sitemap
* Travis CI integration with [html-proofer](https://github.com/gjtorikian/html-proofer)
## { Personal } à la JekyllNow
Want to get { Personal } without messing with jekyll installations and terminal commands?
1. Fork the personal-jekyll-theme repository
2. Rename the forked repository to yourgithubusername.github.io
3. Visit https://yourgithubusername.github.io
4. Start modifying the \_config.yml and editing your blog's posts from Github's online editor or a third party online editor (i.e. [Prose](https://prose.io/))
## Documentation
The theme contains documentation in the form of [blog posts](https://panossakkos.github.io/personal-jekyll-theme/blog/index.html).
## Screenshots
### Header
![Intro](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/index.jpg)
### About
![About](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/about.jpg)
### Latest post preview
![Blog](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/blog.jpg)
### Timeline
![Timeline](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/timeline.jpg)
### Blog Archive
![Archive](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/archive.jpg)
### Gesture navigation instructions
![Instructions](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/swipe.jpg)
### Post page
![Post](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/post.jpg)
### Author blurb
![Blurb](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/blurb.jpg)
### Hashtags
![Tags](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/tags.jpg)
### Categories
![Categories](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/categories.jpg)
### 404
![404](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/404.jpg)
### Mobile rendering
![Web App](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/web-app.jpg)
### Web App mode
![iOS](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/ios.jpg)
![Android](https://dl.dropboxusercontent.com/u/8522559/personal-jekyll-theme/pinned.jpg)
## How to run locally
First, you need to install jekyll and the dependencies of { Personal } by running:
@ -97,15 +60,6 @@ Then, you can build and serve your website by simply running:
./scripts/serve-production
````
## Wiki
Don't forget to list your { Personal } blog in the [Blogs using { Personal }](https://github.com/PanosSakkos/personal-jekyll-theme/wiki/Blogs-using-%7B-Personal-%7D) wiki page in order to drive some traffic to your website :wink:
## Integrating bug fixes and features into your old fork
Have you published your own website by forking { Personal } and now you want to get the latest bug fixes and features from this repo into your website?
Then check [this](https://github.com/PanosSakkos/personal-jekyll-theme/wiki/Upgrading-your-%7B-Personal-%7D-website-with-our-latest-bug-fixes-and-features) out.
## OSS used in { Personal }
One of the reasons { Personal } is real is the following OSS projects:
@ -117,8 +71,26 @@ One of the reasons { Personal } is real is the following OSS projects:
5. [Timeline](https://github.com/kirbyt/timeline-jekyll-theme)
6. [typed.js](https://github.com/mattboldt/typed.js/)
## Supporting the repo
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.0/jquery.min.js"></script>
<script type="text/javascript" src="https://blockchain.info/Resources/wallet-legacy/pay-now-button.js"></script>
Proposals, pull requests and issues are more than welcome, let's make the web a bit more beautiful and secure :wink:
In case you want to say thank you by donating Bitcoins to all the contributors, [this](https://blockchain.info/address/1LHuKC9Em3KA5yoZaf7nngnNdf9K7s2gSi) is our address.
<div style="font-size:16px;margin:0 auto;width:300px" class="blockchain-btn"
data-address="1LHuKC9Em3KA5yoZaf7nngnNdf9K7s2gSi"
data-shared="false">
<div class="blockchain stage-begin">
<img src="https://blockchain.info/Resources/buttons/donate_64.png"/>
</div>
<div class="blockchain stage-loading" style="text-align:center">
<img src="https://blockchain.info/Resources/loading-large.gif"/>
</div>
<div class="blockchain stage-ready">
<p align="center">Please Donate To Bitcoin Address: <b>[[address]]</b></p>
<p align="center" class="qr-code"></p>
</div>
<div class="blockchain stage-paid">
Donation of <b>[[value]] BTC</b> Received. Thank You.
</div>
<div class="blockchain stage-error">
<font color="red">[[error]]</font>
</div>
</div>