README.md in toto-0.2.7 vs README.md in toto-0.2.8

- old
+ new

@@ -7,10 +7,18 @@ ------------ toto is a git-powered, minimalist blog engine for the hackers of Oz. The engine weights around ~300 sloc at its worse. There is no toto client, at least for now; everything goes through git. +blog in 10 seconds +------------------ + + $ git clone git://github.com/cloudhead/dorothy.git myblog + $ cd myblog + $ heroku create myblog + $ git push heroku master + philosophy ---------- Everything that can be done better with another tool should be, but one should not have too much pie to stay fit. In other words, toto does away with web frameworks or DSLs such as sinatra, and is built right on top of **rack**. @@ -22,11 +30,11 @@ Oh, and everything that can be done with git, _is_. how it works ------------ -- content is entirely managed trough **git**; you get full fledged version control for free. +- content is entirely managed through **git**; you get full fledged version control for free. - articles are stored as _.txt_ files, with embeded metadata (in yaml format). - articles are processed through a markdown converter (rdiscount) by default. - templating is done through **ERB**. - toto is built right on top of **Rack**. - toto was built to take advantage of _HTTP caching_. @@ -36,18 +44,25 @@ - the archives can be accessed by year, month or day, wih the same format as above. - arbitrary metadata can be included in articles files, and accessed from the templates. - summaries are generated intelligently by toto, following the `:max` setting you give it. - you can also define how long your summary is, by adding `~` at the end of it (`:delim`). +dorothy +------- + +Dorothy is toto's default template, you can get it at <http://github.com/cloudhead/dorothy>. It +comes with a very minimalistic but functional template, and a _config.ru_ file to get you started. +It also includes a _.gems_ file, for heroku. + synopsis -------- -One would start by forking or cloning the `dorothy` repo, to get a basic skeleton: +One would start by installing _toto_, with `sudo gem install toto`, and then forking or +cloning the `dorothy` repo, to get a basic skeleton: - $ mkdir weblog/ + $ git clone git://github.com/cloudhead/dorothy.git weblog $ cd weblog/ - $ git clone git://github.com/cloudhead/dorothy.git . One would then edit the template at will, it has the following structure: templates/ | @@ -106,27 +121,28 @@ Toto was designed to work well with [heroku](http://heroku.com), it makes the most out of it's state-of-the-art caching, by setting the _Cache-Control_ and _Etag_ HTTP headers. Deploying on Heroku is really easy, just get the heroku gem, create a heroku app with `heroku create`, and push with `git push heroku master`. - $ heroku create - $ heroku rename weblog + $ heroku create weblog $ git push heroku master $ heroku open ### configuration You can configure toto, by modifying the _config.ru_ file. For example, if you want to set the blog author to 'John Galt', you could add `set :author, 'John Galt'` inside the `Toto::Server.new` block. Here are the defaults, to get you started: set :author, ENV['USER'] # blog author set :title, Dir.pwd.split('/').last # site title + set :url, 'http://example.com' # site root URL set :root, "index" # page to load on / set :date, lambda {|now| now.strftime("%d/%m/%Y") } # date format for articles set :markdown, :smart # use markdown + smart-mode set :disqus, false # disqus id, or false set :summary, :max => 150, :delim => /~\n/ # length of article summary and delimiter set :ext, 'txt' # file extension for articles + set :cache, 28800 # cache site for 8 hours thanks ------ To heroku for making this easy as pie.