Permalink
Browse files

updates readme

  • Loading branch information...
jackmcdade committed Mar 30, 2012
1 parent 41834f5 commit 4af8f904f60848f705c9f4c0a73e4394051f288e
Showing with 6 additions and 2 deletions.
  1. +6 −2 README.md
View
@@ -1,8 +1,8 @@
# Chronicle
By Jack McDade (inspired by Travis Schmeisser)
By Jack McDade
Chronicle is a simple, chronilogically organized, file-based publishing engine. It takes a content directory (which can contain literally anything you want, as long as you have an index.php file), adds a little yaml magic for meta data, and powers all the navigation between entries.
Chronicle is a simple, chronilogically organized, file-based publishing engine. It takes a content directory (which can contain literally anything you want, as long as you have an index.php file), adds a little yaml magic for meta data, and powers all the navigation between entries. Inspired in part by my buddy [Travis Schmeisser](http://twitter.com/rockthenroll).
## Getting Started
@@ -18,4 +18,8 @@ Chronicle is a simple, chronilogically organized, file-based publishing engine.
* If you add a `meta.yaml` file to any given content subdirectory, any of the [YAML](http://en.wikipedia.org/wiki/YAML) key:value pairs will be availble to use in both the index.php view and archive listing page.
* Your archive page will pull all the meta data from all of your content directories to help you build a list. Look at `content/archive/index.php` for some examples.
## Helpers
* `asset_path()`: pass in the relative path to any asset (e.g. CSS, JS, image) and it returns the correct full server path. See `content/20120330/index.php` for an example.
### More complete documentation coming soon!

0 comments on commit 4af8f90

Please sign in to comment.