README.md in screenshots-0.0.1 vs README.md in screenshots-0.0.2
- old
+ new
@@ -1,8 +1,9 @@
# Screenshots
-TODO: Write a gem description
+This gem takes a list of URLs, gets the title of each page at those URLs, then builds an HTML string that can be copied-pasted in a blog article to present those web pages.
+It assumes screenshots of those pages would have been uploaded on the blog.
## Installation
Add this line to your application's Gemfile:
@@ -27,9 +28,13 @@
config.image_extension = 'jpg'
end
```
## Usage
+
+### Directly call the binary
+
+ $ screenshots my-input-file.txt my_output_dir
### Generate HTML for a single URL
```ruby
Screenshots::Processor.generate('http://www.google.com')