aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArno Richter <oelna@oelna.de>2017-12-20 00:49:00 +0100
committerArno Richter <oelna@oelna.de>2017-12-20 00:49:00 +0100
commit9b9d74ad74982025443a2a52bd9e116fcae41765 (patch)
treeff705a5ad9db05be479746d9e0dfb83d1f21a479
parent603d4cc48dbd5db29e45cc2a3c5245e1c00384f3 (diff)
downloadmicroblog-9b9d74ad74982025443a2a52bd9e116fcae41765.tar.gz
microblog-9b9d74ad74982025443a2a52bd9e116fcae41765.tar.bz2
microblog-9b9d74ad74982025443a2a52bd9e116fcae41765.zip
updated README.md with a screenshot
-rw-r--r--README.md11
1 files changed, 7 insertions, 4 deletions
diff --git a/README.md b/README.md
index 2c63c72..b427bec 100644
--- a/README.md
+++ b/README.md
@@ -2,18 +2,20 @@
A very simple PHP app that stores twitter-like status updates in a sqlite database. It also generates a JSON feed, that can be used as a source for the [micro.blog](https://micro.blog/) service. It is aimed at people who would like to host their own micro.blog, but want to avoid using Wordpress for it.
+![a screenshot of the microblog app](https://user-images.githubusercontent.com/1279725/34184164-9567a4b2-e51e-11e7-9317-d737ef3423f0.png)
+
There is a timeline view of your own posts, as well as a simple 'compose post' page behind a login form. Right now, only a unique ID, the post content and creation timestamp are saved for each entry, so this is only suitable for one user. (Multiple users would each have to install in their own directories.)
-The entire design is inside a single theme file `microblog.css` and can be modified easily. The site HTML is pretty straightforward and should be easy to style.
+The entire design is inside a single theme file [microblog.css](microblog.css) and can be modified easily. The site HTML is pretty straightforward and should be easy to style.
The app requires at least PHP 5.5 and was tested on 7.0
### Installation
- Copy the files to a directory on your webserver
-- edit `config.php` and adjust the settings if you like (at least set a new password!)
-- edit `.htaccess` and set `RewriteBase` to a path matching your installation directory
-- optional: modify the theme file `microblog.css`
+- edit [config.php](config.php) and adjust the settings if you like (at least set a new password!)
+- edit [.htaccess](.htaccess) and set `RewriteBase` to a path matching your installation directory
+- optional: modify the theme file [microblog.css](microblog.css)
### To Do
@@ -24,4 +26,5 @@ The app requires at least PHP 5.5 and was tested on 7.0
### Support my work
The app is provided for free, but if you'd like to support what I do, please consider tipping.
+
[![Gittip](https://www.dropbox.com/s/23emy7ngeqdnrrc/logo_gittip.png?raw=1)](https://www.gittip.com/oelna/) [![Flattr](https://www.dropbox.com/s/20legqru72ffddw/logo_flattr.png?raw=1)](https://flattr.com/submit/auto?user_id=oelna&url=https%3A%2F%2Fgithub.com%2Foelna%2Fmicroblog&title=microblog&language=en&tags=github&category=software) \ No newline at end of file