README.md in spree_essential_cms-0.1.0 vs README.md in spree_essential_cms-0.1.2
- old
+ new
@@ -9,14 +9,14 @@
If you don't already have an existing Spree site, [click here](https://gist.github.com/946719) then come back later... You can also read the Spree docs [here](http://spreecommerce.com/documentation/getting_started.html)...
Otherwise, follow these steps to get up and running with SpreeEssentialCms:
-Add the necessary gems to your Gemfile... they haven't been released to Rubygems yet so we'll grab them from git.
+Add the necessary gems to your Gemfile:
- gem 'spree_essentials', :git => 'git://github.com/citrus/spree_essentials.git'
- gem 'spree_essential_cms', :git => 'git://github.com/citrus/spree_essential_cms.git'
+ gem 'spree_essentials', '~> 0.2.3'
+ gem 'spree_essential_cms', '~> 0.1.2'
Run the generators to create the migration files.
rails g spree_essentials:install
rails g spree_essentials:cms
@@ -27,11 +27,72 @@
Boot your server and checkout the admin!
rails s
+
+
+Usage
+-----
+
+
+#### Contexts
+
+Contexts allow you to place different forms of content in various places of a page. A slideshow or a sidebar might be good examples...
+
+You can set a content's context (say that ten times fast!) under the 'Optional Fields' tab in the edit content view.
+
+In your view you'll be able to grab those bits of content like so:
+
+ .slideshow
+ - if @slides = @page.for_context('slideshow')
+ = render 'shared/content', :content => @slides
+
+ - if @sidebar = @page.for_context('sidebar').first
+ - content_for :sidebar do
+ = render 'shared/your_custom_sidebar', :content => @sidebar
+
+
+
+
+#### Custom image sizes
+
+Use a content decorator when you want different contexts to have their own image sizes:
+
+
+ Content.class_eval do
+
+ # override default image sizes
+ def default_attachment_sizes
+ { :mini => '48x48>', :medium => '427x287>' }
+ end
+
+ # or set a custom size for each context
+ def attachment_sizes
+ case context
+ when 'slideshow'
+ sizes = default_attachment_sizes.merge(:slide => '955x476#')
+ when 'main'
+ sizes = default_attachment_sizes.merge(:custom => '580x289#')
+ when 'small-top'
+ sizes = default_attachment_sizes.merge(:custom => '364x177#')
+ when 'small-bottom'
+ sizes = default_attachment_sizes.merge(:custom => '364x109#')
+ else
+ sizes = default_attachment_sizes
+ end
+ sizes
+ end
+
+ end
+
+
+
+
+
+
Demo
----
You can easily use the test/dummy app as a demo of spree_essential_cms. Just `cd` to where you develop and run:
@@ -45,18 +106,36 @@
Change Log
----------
+**0.1.2 - 2012/1/6**
+
+* Removed automatic attachment config with SpreeHeroku
+
+
+**0.1.1 - 2011/6/2**
+
+* Added the image_size option `shared/_content.html.erb`
+* Improved documentation
+
+
+**0.1.0 - 2011/6/1**
+
+* Random cleanup
+* Released 0.1.0 to rubygems
+
+
**2011/4/26**
* Extracted from the Spree Essentials core.
To Do
-----
* more tests... many many more.
+* optimizations
* A 'create translation' button that clones the current page's contents into another language
* add widgets that you can drop into any page
* page and menu caching/sweeping
* nested set for pages
* 0.30 and 0.40 compatibility
\ No newline at end of file