Added in README.md

README.md

@@ -1,21 +1,33 @@
 Spree Showcase
 ===========
 
-Introduction goes here.
+Spree Showcase is a simple extension that allows you to create the good ol' slideshow. The goal is to create a slideshow extension that makes things easy for the users and programmers. Minimal effort needed.
 
+The secondary objective is to create a slideshow template that allows most types of JS slider to be implemented easily into Spree. 
+
+Currently, this is the first iteration of the slideshow extension at v0.1. Contributors are greatly welcomed =)
+
+**Next to come:**
+- Adding sliders to different layout positions
+- Enabling more options to be customized in the Admin Menu
 
 Example
 =======
+Get a clean Spree Installation
+
+rails new spree_demo
+cd spree_demo
+spree install
 
-Example goes here.
+gem 'spree_showcase', :git=>"git://github.com/daemonsy/spree_showcase" # Into Gemfile
+
+bundle install
+rails g spree_showcase:install
 
 Testing
 -------
+No tests have been done yet. Use at your own risk! 
 
-Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
-
-    $ bundle
-    $ bundle exec rake test_app
-    $ bundle exec rspec spec
 
-Copyright (c) 2012 [name of extension creator], released under the New BSD License
+Copyright (c) 2012 Damon Aw, released under the New BSD License.
+[What is the BSD license anyway?]

lib/generators/spree_showcase/install/install_generator.rb

@@ -5,15 +5,15 @@ class InstallGenerator < Rails::Generators::Base
 
       def add_javascripts
         puts %q{Copying JS assets into your app's javascripts/store directory. The file showcase.js is required by the extension and is used to activate slideshow.'}
-        copy_file "aw-showcase.js", "apps/assets/javascripts/store/showcase.js"
+        copy_file "aw-showcase.js", "app/assets/javascripts/store/showcase.js"
 
         append_file 'app/assets/javascripts/store/all.js', "//= require store/spree_showcase\n"
 
       end
 
       def add_stylesheets
         puts %q{showcase.css styles are required by the extension and can be changed in anyway to fit your own _showcase.html.erb}
-        copy_file "aw-showcase.css", "apps/assets/stylesheets/store/showcase.css"
+        copy_file "aw-showcase.css", "app/assets/stylesheets/store/showcase.css"
         inject_into_file 'app/assets/stylesheets/store/all.css', " *= require store/spree_showcase\n", :before => /\*\//, :verbose => true
       end