README.md in externallink-0.0.2 vs README.md in externallink-0.0.3
- old
+ new
@@ -1,8 +1,8 @@
# Externallink
-TODO: Write a gem description
+Helper to detect external urls.
## Installation
Add this line to your application's Gemfile:
@@ -18,14 +18,30 @@
$ gem install externallink
## Usage
-TODO: Write usage instructions here
+This gem works out of the box for Rails applications and provides the following helpers.
+### `external_url?`
+
+Checks if the given URL is external or not.
+Example (when the app domain is example.com):
+
+```ruby
+external_url?("http://www.google.com") # => true
+external_url?("/foo") # => false
+external_url?("http://example.com/foo") # => false
+```
+
+### `internal_url?`
+
+The opposite behavior of `external_url?`
+
+
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/externallink/fork )
+1. Fork it ( https://github.com/xarsh/externallink/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request