index.txt in echi-converter-0.3.4

- old
+ new

@@ -20,17 +20,21 @@
 	# 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
-	# Supports inserting agent names from agname.dat
+	# Supports inserting data from the various '.dat' files provided
 	# Runs as a daemon (via fork) on *NIX and a service on Windows
+	# Allows for multiple FTP sessions to be used for greater performance (via "green threads":http://en.wikipedia.org/wiki/Green_threads)
 
 # Table names:
 ## echi_records - stores all ECHI data        
 ## echi_logs - stores a log entry for each file processed
 ## echi_agents - stores the data from the agname.dat file 
+## echi_aux_reasons - stores the data from the aux_rsn.dat file
+## echi_cwcs - stores data from the cwc.dat file
+## echi_vdns - stores data from the vdn.dat file
 
 
 h2. Requirements
 
 	# "Ruby v1.8.6+":http://www.ruby-lang.org/
@@ -77,17 +81,17 @@
 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:
+For POSIX:
 
 # 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
+# echi-converter zap myproject - 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 - if the directory name or path has any spaces, please enclose the "myproject" in double quotes )
 # echi-converter start - start the service
@@ -98,18 +102,34 @@
 # echi-converter delete - delete the service"
 
 # If you would like to run the script interactively, you may also execute this command: 
 ## ruby "c:\myproject\lib\main_win32.rb"
 
+Multi-byte character support:
+
+# If you require multi-byte character support be sure to set your database to 'utf8' as well as uncomment the option 'encoding: utf8' in the config/database.yml file
+
 h2. Demonstration of usage
 
 Start the daemon/service:
 
 <pre syntax="ruby">echi-converter start myproject</pre>
 
 Stop the daemon/service:
 
 <pre syntax="ruby">echi-converter stop myproject</pre>
+
+h2. Supported Platforms
+
+While the use of Ruby allows for operation on a multitude of platforms, these are the platforms that have actually been tested on.  If you have success running on other platforms, please feel free to provide details on the Google Group.
+
+h4. Operating Systems
+
+POSIX, Windows XP SP2, Windows 2000 and Windows 2003.
+
+h4. FTP Servers
+
+VSFTP and Windows 2003/XP FTP Servers.
 
 h2. Screencast
 
 You may view the screencast on howto install and use the ECHI-Converter "here":http://www.screencast.com/t/lQQkIVkUZMr.
 