Permalink
Browse files

readme and licence changes

  • Loading branch information...
1 parent 32372a0 commit d4d4d8a90ea1c893413e2117e58c53dc679c66ab Dirk Kelly committed Oct 23, 2010
Showing with 83 additions and 45 deletions.
  1. +42 −0 LICENSE
  2. +0 −20 MIT-LICENSE
  3. +41 −25 README.md
View
42 LICENSE
@@ -0,0 +1,42 @@
+Copyright (c) 2010 Dirk Kelly (dk@dirkkelly.com) (SquareTalent)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+---------------------------------------------------------------------------
+
+Copyright (c) 2008-2009 Aurora Software (http://www.aurorasoft.com.au)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,20 +0,0 @@
-Copyright (c) 2008-2009 Aurora Software (http://www.aurorasoft.com.au)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,36 +1,52 @@
# Radiant Shop
-ps: [wiki](http://github.com/squaretalent/radiant-shop-extension/wiki)
+## [Wiki]([wiki.github.com/squaretalent/radiant-shop-extension] "Github Wiki Page")
-pps: heavily under development means "it might not work out of the box after every commit"
+## Quickstart
-ppps: I am working on the wiki as quickly as I can, but specs are more important at this point in time
+Install RadiantShop Gem
-pppps: love heart
+ gem install radiant-shop-extension
+ # This will install Radiant and the Gems RadiantShop requires
+
+Create a Radiant project
+
+ radiant myshop --database sqlite3
+ cd myshop
+
+Edit your Gemfile
-## Checkout
+ gem 'radiant', '0.9.1'
+ gem 'radiant-shop-extension', :require => false
+
+Add to your config/environment.rb
-### Form Configuration
+ config.gem 'radiant-settings-extension', :lib => false
+ config.gem 'radiant-scoped-extension', :lib => false
+ config.gem 'radiant-images-extension', :lib => false
+ config.gem 'radiant-forms-extension', :lib => false
+ config.gem 'radiant-shop-extension', :lib => false
+
+Bootstrap Radiant (answer questions, I suggest an empty template)
- checkout:
- gateway:
- name: Eway
- username: 123456
- password: abcdef
-
-# Development
+ rake db:bootstrap
+
+Migrate shop
- unless ENV["RAILS_ENV"] == "production"
- config.gem 'rspec', :version => '1.3.0'
- config.gem 'rspec-rails', :version => '1.3.2'
- config.gem 'cucumber', :verison => '0.8.5'
- config.gem 'cucumber-rails', :version => '0.3.2'
- config.gem 'database_cleaner', :version => '0.4.3'
- config.gem 'ruby-debug', :version => '0.10.3'
- config.gem 'webrat', :version => '0.7.1'
- config.gem 'rr', :version => '0.10.11'
- end
+ rake radiant:extensions:update_all
+ rake radiant:extensions:shop:migrate
-# Migrating in Development
+Seed shop (optional, will help you get on your way)
+
+ rake radiant:extensions:shop:seed
+
+## Licence
+
+This extension started as a fork of aurora-soft's simple product manager
+and has since undergone a rewrite.
+
+http://github.com/squaretalent/radiant-shop-extension/compare/master
+
+Copyright 2010 Dirk Kelly (dk@dirkkelly.com) and licenced under MIT.
- rm db/development.sqlite3.db; rake db:migrate; rake radiant:extensions:scoped:migrate; rake radiant:extensions:settings:migrate; rake radiant:extensions:drag:migrate; rake radiant:extensions:forms:migrate; rake radiant:extensions:images:migrate; rake radiant:extensions:shop:migrate; rake radiant:extensions:export:load;
+See LICENCE for further information.

0 comments on commit d4d4d8a

Please sign in to comment.