README.markdown in datashift_spree-0.1.0 vs README.markdown in datashift_spree-0.2.0
- old
+ new
@@ -1,10 +1,10 @@
## DataShift
Specific loaders and command line tasks for Spree E-Commerce.
-Wiki here : **https://github.com/autotelik/datashift/wiki**
+Wiki here : **https://github.com/autotelik/datashift_spree/wiki**
### Features
Import and Export Spree models through .xls or CSV files, including
all associations and setting configurable defaults or over rides.
@@ -19,47 +19,51 @@
Many example Spreadsheets/CSV files in spec/fixtures, fully documented with comments for each column.
## Installation
-Add gem 'datashift' to your Gemfile/bundle, or install the latest gem as usual :
- gem install datashift
+Add to bundle :
-To use :
+ gem 'datashift_spree'
- gem 'datashift'
- require 'datashift'
+Create a high level .thor file - e.g mysite.thor - in your applications root directory
-To use the Thor command line applications :
-
- Create a high level .thor file - e.g mysite.thor - in your applications root directory
-
-Edit the file and add the following to pull in the thor commands :
-
```ruby
- require 'thor'
- require 'datashift'
-
- DataShift::load_commands
+require 'datashift_spree'
+DataShift::SpreeHelper::load_commands
```
+
To check the available tasks run
bundle exc thor list datashift
To get usage information use thor help <command>, for example
- bundle exec thor help datashift:generate:excel
+ bundle exec thor help datashift:spree:products
+```ruby
+Usage:
+ thor datashift:spree:products -i, --input=INPUT
+Options:
+ -i, --input=INPUT # The import file (.xls or .csv)
+ -s, [--sku-prefix=SKU_PREFIX] # Prefix to add to each SKU before saving Product
+ -v, [--verbose] # Verbose logging
+ -c, [--config=CONFIG] # Configuration file containg defaults or over rides in YAML
+
+Populate Spree Product/Variant data from .xls (Excel) or CSV file
+```
+
+
## License
Copyright:: (c) Autotelik Media Ltd 2012
Author :: Tom Statter
-Date :: Dec 2012
+Date :: Oct 2012
The MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
\ No newline at end of file