Permalink
Browse files

updated README and gemspec

  • Loading branch information...
markburns committed Feb 20, 2012
1 parent 41b9ad9 commit e20b9b0a02ba4e4aedbc2dbf207056ac2006415d
Showing with 13 additions and 6 deletions.
  1. +7 −3 README.md
  2. +6 −3 ldoce.gemspec
View
@@ -1,6 +1,5 @@
# Ldoce
-
-TODO: Write a gem description
+Easily interface with the Longman Dictionary of Contemporary English API from Ruby:
## Installation
@@ -18,7 +17,12 @@ Or install it yourself as:
## Usage
-TODO: Write usage instructions here
+```ruby
+cat = Word.search 'cat'
+cat.play #plays mp3 sample - only working for Mac at the moment
+cat.definition
+#=> "A small four legged animal commonly kept as a pet"
+```
## Contributing
View
@@ -4,9 +4,12 @@ require File.expand_path('../lib/ldoce/version', __FILE__)
Gem::Specification.new do |gem|
gem.authors = ["Mark Burns"]
gem.email = ["markthedeveloper@gmail.com"]
- gem.description = %q{TODO: Write a gem description}
- gem.summary = %q{TODO: Write a gem summary}
- gem.homepage = ""
+ gem.description = %q{API for the Longman Dictionary of Contemporary English}
+ gem.summary = %q{So far covers playing mp3 media files and fetching definitions}
+ gem.homepage = "https://github.com/markburns/ldoce"
+
+ gem.add_dependency 'httparty'
+
gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
gem.files = `git ls-files`.split("\n")

0 comments on commit e20b9b0

Please sign in to comment.