Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ozzi- authored Jul 31, 2018
1 parent db1ef76 commit 7a9ab5b
Showing 1 changed file with 22 additions and 7 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
# µblog
Easy to setup, integrate into existing pages and customize micro blog. Requires PHP only (no database needed).
Easy to setup, integrate into existing pages and customize micro blog.
Requires PHP only (no database needed).

# Adding content
Blog posts are stored as html files, so you can use whatever mark-up you like.
The first line of the file is interpreted as the post title. The order of the posts is managed by the file names, that's why all files should be named like the following {incrementing number}.html
## Installation
0. Download the newest release from https://github.com/ozzi-/-blog/releases
1. Unzip folder
2. Copy to your www root folder
3. Done

# Configuration
## Adding content
Blog posts are stored as html files - you can use whatever mark-up you like.
The first line of the file is interpreted as the post title.
The order of the posts is managed by the file names, that's why all files should be named like the following {incrementing number}.html

## Configuration
blogconfig.php contains three variables, thats all it takes setting up the blog.

# Changing the design
In the templates folder you can tweak µblog design easily.
## Changing the design
In the templates folder you can tweak µblog design with ease.
Terms in dobule curly brackets will be replaced by µblog automagically.
Example of header.html:

```<div class='blogTitle'>
<a href="{{linkHome}}" class="linkNoDecoration">A new &#181;blog instance</a>
</div><br>
```

# Live demo
Everybody likes live demos!
Expand Down

0 comments on commit 7a9ab5b

Please sign in to comment.