Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
buren committed Apr 2, 2015
1 parent e3d5e0d commit 4d4f16b
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,17 @@ SiteMapper.map('example.com', logger: :system) do |new_url|
end
```

## Docs

You can find the docs online on [RubyDoc](http://www.rubydoc.info/github/buren/site_mapper/master).

This gem is documented using `yard` (run from the root of this respository).

```bash
yard # Generates documentation to doc/
```


## Contributing

Contributions, feedback and suggestions are very welcome.
Expand All @@ -58,6 +69,13 @@ Contributions, feedback and suggestions are very welcome.

* Special thanks to the [robots](https://rubygems.org/gems/robots) gem, which provided the bulk of the code in `lib/robots.rb`

## Alternatives

There are a couple of __great__ alternatives, which are more mature and has more features than this Gem and has. Please feel free to check them out:

* [spidr](https://github.com/postmodern/spidr#readme)
* [anemone](https://github.com/chriskite/anemone#readme)

## License

[MIT License](LICENSE)

0 comments on commit 4d4f16b

Please sign in to comment.