added a better readme and fixed the gemspec

.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-before_install: gem install bundler -v 1.10.6

README.md

@@ -1,34 +1,53 @@
 # Edgedetect
 
-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/edgedetect`. To experiment with that code, run `bin/console` for an interactive prompt.
+EdgeDetect is a pure ruby implementation of an edge detect algorithm. It is by 
+no means fast enough to be considered useful in a real world application, it 
+is just a proof of concept. It is build around the ChunkyPNG gem and therefore 
+can only work with PNG files. 
 
-TODO: Delete this and the text above, and describe your gem
+**Warning:** Because I find it hard to test a purely subjective experience of 
+a good edge detection, I didn't write tests in the normal way. If you run the 
+tests some basic math stuff will be tested, but the final edge detection is 
+not tested, instead you can view the results in the `test/output` folder.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'edgedetect'
+gem 'edgedetect', github: "timkaechele/edgedetect"
 ```
 
 And then execute:
 
+```sh
 $ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install edgedetect
+```sh
+$ git clone git@github.com:timkaechele/edgedetect.git
+$ cd edgedetect
+$ rake install
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+There are two basic EdgeDetect implementations, one that naively builds the 
+difference between the gray value of each individual pixel and one more 
+advanced but also slower one, that uses the sobel operation to detect
+the edges. Both can be used in the same way.
 
-## Development
+```ruby
+image = ChunkyPNG::Image.from_file("myfile.png")
 
-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.
+naive = EdgeDetect::EdgeDetector.new(image)
+sobel = EdgeDetect::SobelEdgeDetector.new(image)
 
-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).
+naive.detect_edges # => ChunkyPNG::Image
+sobel.detect_edges # => ChunkyPNG::Image
+```
 
 ## Contributing
 

edgedetect.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Tim Kächele"]
   spec.email         = ["mail@timkaechele.me"]
 
-  spec.summary       = %q{TODO: Write a short summary, because Rubygems requires one.}
+  spec.summary       = "Edge Detection written in Ruby"
-  spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.description   = "A pure ruby implementation of an naive edge detection algorithm, as well as the sobel algorithm."
-  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.homepage      = "https://github.com/timkaechele/edgedetect"
   spec.license       = "GNU GPL v2"