README.rdoc in serious-0.1.4 vs README.rdoc in serious-0.2.0
- old
+ new
@@ -1,9 +1,9 @@
= Serious
Serious is a blog engine inspired by other filesystem-based engines like jekyll (http://jekyllrb.com/)
-and toto (http://cloudhead.io/toto), but is based upon Sinatra and rack and thus can be hosted
+and toto (http://cloudhead.io/toto) and is based upon Sinatra and rack, thus can be hosted
very easily (and for free) on heroku (http://heroku.com).
The articles are stored in plain text files with an opinionated naming scheme which is used for
getting the date and permalink of your article: <code>articles/2010-02-14-will-you-be-my-valentine.txt</code>
@@ -16,11 +16,11 @@
Some nice summary.
~
## Some content. You can use markdown in your articles, and also <%= "erb" %>
<% highlight do %>
- puts 'it will also syntax-highlight your codes'
+ puts "it will also syntax-highlight your codes"
<% end %>
There are quite a few assumptions made by this format: You have to specify your title in yaml format
upfront. You can also specify an author for this article. If you don't, it will fall-back to the
default one (see configuration). Then two newlines must follow to seperate the yaml from the actual
@@ -78,10 +78,16 @@
thin -R config.ru start
Go to <code>localhost:3000</code> and enjoy.
+== Archives
+
+The whole archives can be accessed at <code>/archives</code>. Archives by year, month and date
+are available at <code>/2009</code> (all of 2009), <code>/2009/05</code> (May 2009),
+<code>/2009/05/15</code> (May 15th 2009).
+
== Configuration
Inside your config.ru, you can customize the settings for your Serious site.
=== Custom view templates or public folder
@@ -193,11 +199,13 @@
== TODO
* static pages
* make summary delim configurable
+* beautifuller date formatting in frontend
* make caching better
+* make it possible to host in subdirectories
* valid xhtml in demo setup
* generator for basic app?
* rake tasks for generating new posts and validating existing
* disqus (optional)
* google analytics (optional)
@@ -210,9 +218,14 @@
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
+
+== Thanks
+
+Alexis Sellier for toto, the main inspiration for this gem
+Ryan Bates for the great coderay css
== Copyright
Copyright (c) 2010 Christoph Olszowka. See LICENSE for details.