Merge pull request #25 from sul-dlss/cleanup

markdown, not rdoc.  remove yard.

.gitignore

@@ -10,5 +10,4 @@ log/*
 pkg/*
 tags
 tmp
-.yardoc/*
 Gemfile.lock

README.md

@@ -0,0 +1,46 @@
+[![Build Status](https://travis-ci.org/sul-dlss/assembly-objectfile.svg?branch=master)](https://travis-ci.org/sul-dlss/assembly-objectfile)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/2310962acce78d78e76c/test_coverage)](https://codeclimate.com/github/sul-dlss/assembly-objectfile/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2310962acce78d78e76c/maintainability)](https://codeclimate.com/github/sul-dlss/assembly-objectfile/maintainability)
+
+# Assembly-ObjectFile Gem
+
+## Overview
+This gem contains classes used by the Stanford University Digital Library to
+perform file operations necessary for accessioning of content.  It is also
+used by related gems to perform content type specific operations (such as jp2
+generation).
+
+## Usage
+
+The gem currently has methods for:
+* filesize
+* exif
+* generate content metadata
+
+## Running tests
+
+```
+bundle exec spec
+```
+
+## Releasing the gem
+
+```
+rake release
+```
+
+## Prerequisites
+
+1.  Exiftool
+
+    RHEL: (RPM to install comming soon) Download latest version from:
+    http://www.sno.phy.queensu.ca/~phil/exiftool
+
+        tar -xf Image-ExifTool-#.##.tar.gz
+        cd Image-ExifTool-#.##
+        perl Makefile.PL
+        make test
+        sudo make install
+
+    Mac users:
+        brew install exiftool

assembly-objectfile.gemspec

@@ -30,5 +30,4 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rubocop-rspec'
   s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'yard'
 end

spec/object_file_spec.rb

@@ -172,7 +172,7 @@
     expect(@ai.object_type).not_to eq(:image)
     expect(@ai.valid_image?).to eq(false)
 
-    non_image_file = File.join(Assembly::PATH_TO_GEM, 'README.rdoc')
+    non_image_file = File.join(Assembly::PATH_TO_GEM, 'spec/test_data/input/file_with_no_exif.xml')
     expect(File.exist?(non_image_file)).to be true
     @ai = described_class.new(non_image_file)
     expect(@ai.image?).to eq(false)