Skip to content

Commit adc6458

Browse files
committed
Add link to gem documentation in readme
1 parent 02cd190 commit adc6458

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,12 @@ result.posts # will include all returned posts
4040

4141
The `twingly-search` gem talks to a commercial blog search API and requires an API key. Best practice is to set the `TWINGLY_SEARCH_KEY` environment variable to the obtained key. `Twingly::Search::Client` can be passed a key at initialization if your setup does not allow environment variables.
4242

43-
Example code can be found in [examples/](examples/).
43+
To learn more about the features of this gem, read the [gem documentation] or check out the example code that can be found in [examples/](examples/).
4444

45-
To learn more about the capabilities of the API, please read the [Twingly Search API documentation](https://developer.twingly.com/resources/search/).
45+
To learn more about the capabilities of the API, please read the [Twingly Search API documentation].
46+
47+
[gem documentation]: http://www.rubydoc.info/github/twingly/twingly-search-api-ruby
48+
[Twingly Search API documentation]: https://developer.twingly.com/resources/search/
4649

4750
## Requirements
4851

0 commit comments

Comments
 (0)