README.md in copy-0.0.41 vs README.md in copy-0.1.0
- old
+ new
@@ -1,9 +1,68 @@
-## Copy is a sinatra-based content management system.
+# Copy is a simple, Sinatra-based content management system.
-Copy is similar to [Brochure](https://github.com/sstephenson/brochure) in spirit, but with the addition of editable text blocks.
+`$ gem install copy` and then generate a new site `$ copy -n mynewsite`
-More soon.
+ mynewsite/
+ ├── Gemfile <- Uncomment the gems you need for storage.
+ ├── config.ru <- Configure storage, user, and password here.
+ ├── public <- The public root of your new site.
+ │ ├── favicon.ico Ships with a few helpful defaults.
+ │ ├── images
+ │ ├── javascripts
+ │ │ └── main.js
+ │ ├── robots.txt
+ │ └── stylesheets
+ │ └── main.css
+ └── views <- Your views, layouts, and partials live here.
+ ├── index.html.erb
+ └── layout.html.erb
+
+The layout (`layout.html.erb`) yields to all the views. It's not required so delete it if your views contain full html documents.
+
+Copy automatically maps URLs to files in your `views` directory.
+
+* `/` → `index.html.erb`
+* `/about` → `about.html.erb` or `about/index.html.erb`
+* `/about/us` → `about/us.html.erb`
+
+Copy lets you define blocks of editable text in your views.
+
+ <% copy :contact do %>
+ 1 _Infinite_ Loop
+ Cupertino, CA 95014
+ 408.996.1010
+ <% end %>
+
+The text provided in the block will be saved and can then be edited live on the site. All content is formatted with Markdown. [See demo](http://copy-demo.heroku.com) for a live example or [view the source](https://github.com/javan/copy-demo).
+
+Single line blocks will be edited in a text field as opposed to a textarea. Perfect for headlines.
+
+ <h1><% copy :title %>Like a boss!<% end %></h1>
+
+**Partials** can be rendered from any view with the `partial` helper. Their filenames are always prefixed with an underscore.
+
+* `<%= partial 'nav' %>` renders `_nav.html.erb`
+* `<%= partial 'shared/details' %>` renders `shared/_details.html.erb`
+
+----
+
+### Storage
+
+Copy supports multiple backends for storage: redis, mongodb, mysql, postgres, and sqlite.
+
+Choosing and configuring your storage option is done in one line in your `config.ru` file by providing a connection URI.
+
+Examples:
+
+* `set :storage, 'mongodb://user:pass@host:port/database'`
+* `set :storage, 'postgres://user:pass@host/database'`
+
+----
+
+### Editing copy on your live site
+
+Browse to `/_copy` and drag the "Edit Copy" link to your bookmarks bar. Return to your site, click the bookmark (you'll be prompted for your username and password) and then click on the highlighted text to edit it. That's it!
----
© 2011 Javan Makhmali
\ No newline at end of file