Permalink
Browse files

Improvement of README.

  • Loading branch information...
yoosee committed Mar 18, 2016
1 parent 4f2063e commit 3ae9058f4c0e7305b43eee44700b49a67e4a3b4e
Showing with 8 additions and 4 deletions.
  1. +8 −4 README.md
View
@@ -55,19 +55,19 @@ if you want to restart or stop, please replace 'start' with 'restart' or 'stop'.
Setup Nginx or other HTTPD and connect it to Unicorn.
After the installation, access to **http(s)://<your-base-url>/setup** for registering first User and Blog, then login.
After the installation, access to **http(s)://\<your-base-url\>/setup** for registering first User and Blog, then login.
## Basic Usage of writing Articles.
After logged in, click 'New Article' in 'Article' dropdown to start writing an article. It will be visible from the internet when its status set to 'publish'. Until then it'll be appeared in 'Drafts'.
After logged in, click 'New Article' in 'Admin' dropdown to start writing an article. It will be visible from the internet when its status set to 'published'. Until then it'll be appeared in 'Drafts'.
### Markdown
Article should be written in Markdown format. It supports PHP extention format of fenced_code_blocks, tables, etc.
### Image upload and use in markdown
You can Drag & Drop image to the browser area for uploading images. When upload completed, you can see (id:N) on the image which can be used in markdown like '\!\[Image Alt\]\(id:N\)'. You can review uploaded images from 'Media' link in dropdown menu.
You can Drag & Drop image to the browser area for uploading images. When upload completed, you can see (id:N) on the image which can be used in markdown like **\!\[Image Alt\]\(id:N\)**. You can review uploaded images from 'Media' link in dropdown menu.
## Package dependencies
@@ -89,5 +89,9 @@ Following libraries are used for the application. Those are already included or
## Known issues (or Todo list)
There's no role & privilege control between User and Blog. It's all flat for now.
* There's no role & privilege control between User and Blog. It's all flat for now.
* Several design components haven't yet been configurable (e.g. Blog image, CSS, HTML template, favicon.ico, etc.)
* Blog distenguished by hostname, not baseurl itself.
* Image size from Medium is not configurable.
* Some JavaScript and CSS have loading issue (taggable, etc.)

0 comments on commit 3ae9058

Please sign in to comment.