index.txt in echi-converter-0.3.0

- old
+ new

@@ -20,10 +20,11 @@
 	# Generate your schema via ActiveRecord Migrations
 	# Fetch Binary or ASCII CSV files from the Avaya CMS platform via FTP
 	# Convert from the defined Binary format to ASCII
 	# Insert the records into the defined database table using database transactions, via ActiveRecord, on a per file basis to support recovery on failure
 	# Change schema structure via YML configuration file to accommodate various releases of the ECHI format
+	# Runs as a daemon (via fork) on *NIX and a service on Windows
 
 # Table names:
 ## echi_records - stores all ECHI data        
 ## echi_logs - stores a log entry for each file processed
 
@@ -35,10 +36,11 @@
 	# "ActiveRecord v1.15.3+":http://activerecord.rubyforge.org/
 	# "ActiveSupport v1.4.2+":http://activesupport.rubyforge.org/
 	# "Daemons v1.0.7+":http://daemons.rubyforge.org/
 	# "FasterCSV v1.2.0+":http://fastercsv.rubyforge.org/
 	# "Rake v0.7.3+":http://rake.rubyforge.org/
+        # "Win32-service v.0.5.2+":http://win32utils.rubyforge.org/ (Manual install for Windows only)
     # "Hoe v1.2.2+":http://rubyforge.org/projects/seattlerb/
 
 
 h2. Installing
 
@@ -72,17 +74,28 @@
 h2. Usage
 
 # echi-converter create myproject - create the local project to run the ECHI converter from
 # echi-converter upgrade myproject - location of project to upgrade after a new gem is installed
 
+For *NIX:
+
 # echi-converter run myproject - Run the ECHI converter interactively from the location given
 # echi-converter start myproject - Start the ECHI converter in daemon mode from the location given
 # echi-converter stop myproject - Stop the ECHI converter daemon
 # echi-converter restart myproject - Restart the ECHI converter 
 # echi-converter zap myrpoject - If there has been an unexpected close and the system still thinks the converter is running, clean up the pid files
 
+For Windows:
 
+# echi-converter install myproject - install the service (must specify complete path such as c:\path\to\my\project )
+# echi-converter start - start the service
+# echi-converter stop - stop the service
+# echi-converter pause - pause the service
+# echi-converter resume - resume the service
+# echi-converter uninstall - uninstall the service
+# echi-converter delete - delete the service"
+
 h2. Demonstration of usage
 
 Start the daemon/service:
 
 <pre syntax="ruby">echi-converter start myproject</pre>
@@ -90,14 +103,16 @@
 Stop the daemon/service:
 
 <pre syntax="ruby">echi-converter stop myproject</pre>
 
 
-h2. ToDo
+h2. Limitations
 
 Items to be done to move this out of alpha stage:
 
-# 'echi-converter create' works fine with OSX/Linux, need to test validate with a Win32 platform, therefore currently recommended to only run on a Linux/OSX platform, could use "VMWare":http://www.vmware.com to do this on Windows.
+# There are currently two limitations when running on Windows
+## Project directories may not have spaces
+## The Ruby interpreter must be installed in the default location of c:\ruby\bin
 
 h2. Screencast
 
 You may view the screencast on howto install and use the ECHI-Converter "here":http://www.screencast.com/t/lQQkIVkUZMr.
 