README.md in linsc-0.0.11 vs README.md in linsc-0.0.12

@@ -1,35 +1,68 @@
 # Linsc
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/linsc`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Installation
 
-TODO: Delete this and the text above, and describe your gem
+### Windows
 
-## Installation
+- Make sure Powershell is installed
 
-Add this line to your application's Gemfile:
+- Download the Windows Ruby installer from here: http://rubyinstaller.org/downloads/
 
+- Install ruby
+
+- Open Powershell and run the command:
 ```ruby
-gem 'linsc'
+gem install linsc
 ```
 
-And then execute:
+- When installation is completed find your gem directory with:
+```ruby
+gem environment
+```
 
-    $ bundle
+- Navigate to the path listed for INSTALLATION DIRECTORY, then gems -> linsc-(version) -> data
 
-Or install it yourself as:
+- Here you will find an empty proxies.txt and recruiters.txt
 
-    $ gem install linsc
+- Fill the recruiters file with your recruiters, ordered by priority. One recruiter per line, comma separated like this:
+```
+LIN1,
+LIN2,
+LIN3,
+LIN4
+```
 
+- Fill proxies.txt, one proxy per line in the form ip:port or ip:port:username:password if using a username/password with the proxies.
+```
+108.123.523.23:8080:admin:pass
+108.123.523.123:8080:admin:pass
+108.123.523.535:8080:admin:pass
+```
+(username and password optional)
+
 ## Usage
 
-TODO: Write usage instructions here
+- Download your linkedin connections export csv files and put them in an empty directory. Each of these files should have exactly the same filename as one of the lines from your recruiters.txt file.
+It is expected that these csvs will have the following fields: First Name, Last Name, E-mail Address, Company, Job Title. All other fields are ignored.
 
-## Development
+- Run a Salesforce report and put the csv in the same directory as your LIN files. The required fields for the Salesforce file are: Contact ID, LIN ID, Email.
+This file should be named sf_ref.csv
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- In Powershell (or any terminal), navigate to the directory and run this command:
+```
+linsc
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- There are several optional flags you can provide to modify behaviour. To see the full list of available flags, run:
+```
+linsc -h
+```
+
+- If all proxies get blocked the program will exit. Wait a few hours or a day for the proxies to cool off, then run linsc again. It will pick up where it left off.
+
+- When scraping is complete, import your data. If you had the -i flag set, you must import the contact_insert csv, then export a new report with the fields: LIN ID, Contact ID.
+Name this csv history_ref.csv and put it in the same folder as your data. Run linsc again with the -e flag set and the new Contact IDs will be mapped to the education and employment histories for the new contacts. You can now import these new history objects.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/danmolloy/linsc.