diff --git a/README.md b/README.md index 3155b02..6ae2e40 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,26 @@ -Pelican Clean Blog Theme -======================== +# Pelican Clean Blog Theme Theme based in Clean Blog layout. ![Screenshot](https://archive.org/download/6731240/6731240.png) +## Basic configuration + +To define custom header cover, set the property ``HEADER_COVER`` in ``pelicanconf.py``: + +```python +HEADER_COVER = 'static/my_image.png' +``` + +Github, Twitter and Facebook URLs set these properties: + +```python +GITHUB_URL = 'http://github.com/myprofile' +TWITTER_URL = 'http://twitter.com/myprofile' +FACEBOOK_URL = 'http://facebook.com/myprofile' +``` + +If you have insert new links, customize ``base.html``. + Source: http://ironsummitmedia.github.io/startbootstrap-clean-blog/ +