Skip to content

Commit

Permalink
Updated the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
dpp committed Jun 11, 2012
1 parent 8fb1c88 commit ce48cb7
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
@@ -0,0 +1 @@
*~
38 changes: 35 additions & 3 deletions README.md
@@ -1,4 +1,36 @@
template-base
=============
## The default template for [Telegram](https://telegr.am) sites

The Base Template for Telegram sites
This template is the default template for Telegram sites. It's based on
[Twitter Bootstrap](http://twitter.github.com/bootstrap/) with modifications
and enhancements based on [Addy Osmani's](http://addyosmani.github.com/jquery-ui-bootstrap/) stuff.

Include this template in your site by putting the following line
at the top of your `index.md` file:

default_template: https://github.com/telegr-am/template-base.git

So that your `index.md` looks something like:

default_template: https://github.com/telegr-am/template-base.git

# Hello

I am a page

Alternatively, you can put it in Hoisted's faux reference metadata format:


# Hello

I am a page

[default_template: https://github.com/telegr-am/template-base.git]: /

You can also fork the template and change it up to your heart's content and then
use the `default_template` metadata to point to your public GitHub repository
with the template in it.

We will also gladly accept pull requests if there are fixes or enhancements to this
template.

Rock and Roll!

0 comments on commit ce48cb7

Please sign in to comment.