README.md in janis-0.1.2 vs README.md in janis-0.1.3

- old
+ new

@@ -1,5 +1,10 @@ +#####Dependency issues are welcome to be reported in this repo at Issues section. Please include: + 1. Your Operating System + architecture (Example: "Ubuntu 32 bits"). + 2. Full error backtrace. + 3. Your ruby version (you can see it by typing "ruby -v" in your command prompt. + # Janis Janis will help you find proxy servers quickly, by grabbing them from a list of many (hopefully available and up-to-date) proxy listing websites. You can also tell Janis to parse from a specific website and it will do it if it knows how to. If it doesn't you can improve it by adding new Parsers (more on this on Usage section). ## Installation @@ -15,11 +20,22 @@ $ bundle Or install it yourself as: $ gem install janis + +Then download the latest version of PhantomJS from http://phantomjs.org/download.html, according +to your platform. +Place the PhantomJs executable somewhere in your PATH. + +On Unix, you can see your path from your shell by typing '$PATH'. +Common folders to place phantomjs binary in are /usr/bin and usr/local/bin. + +On Windows, you can consult your PATH from your system settings in "Environment Variables" section. +C:\windows\system32\ is a common location you can place phantomjs.exe in. + ## Usage From your own script/app or from irb, require the gem with: ```ruby require 'janis' ``` @@ -82,11 +98,9 @@ 6. Wait for the applauses to come! ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -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). ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/mgiagante/janis.