From 54c5a263789f97a383cd64b572bc683608978df7 Mon Sep 17 00:00:00 2001 From: Pixelastic Date: Thu, 21 Dec 2017 18:47:29 +0100 Subject: [PATCH] Update readme with Gemfile example --- README.md | 30 +++++++++--------------------- 1 file changed, 9 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index d76f15b..223f516 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ This will push the content of your Jekyll website to your Algolia index. ## Documentation -Official documentation can be found on +Full documentation can be found on [https://community.algolia.com/jekyll-algolia/](https://community.algolia.com/jekyll-algolia/) ## Installation @@ -32,7 +32,7 @@ section. # Gemfile group :jekyll_plugins do - gem 'jekyll-algolia' + gem 'jekyll-algolia', '~> 1.0' end ``` @@ -44,8 +44,8 @@ You need to provide certain Algolia credentials for this plugin to *index* your site. *If you don't yet have an Algolia account, you can open a free [Community plan -here][9]. Once signed in, you can get your credentials from -[your dashboard][10].* +here][7]. Once signed in, you can get your credentials from +[your dashboard][8].* Once you have your credentials, you should define your `application_id` and `index_name` inside your `_config.yml` file like this: @@ -71,7 +71,7 @@ Note that `ALGOLIA_API_KEY` should be set to your admin API key. # Thanks -Thanks to [Anatoliy Yastreb][21] for a [great tutorial][22] on creating Jekyll +Thanks to [Anatoliy Yastreb][9] for a [great tutorial][10] on creating Jekyll plugins. @@ -81,19 +81,7 @@ plugins. [4]: https://codeclimate.com/github/algolia/jekyll-algolia/badges/gpa.svg [5]: https://img.shields.io/badge/jekyll-%3E%3D%203.6.0-green.svg [6]: https://img.shields.io/badge/ruby-%3E%3D%202.3.0-green.svg -[7]: https://pages.github.com/versions.json -[8]: http://bundler.io/ -[9]: https://www.algolia.com/users/sign_up/hacker -[10]: https://www.algolia.com/licensing -[11]: http://www.methods.co.nz/asciidoc/ -[12]: https://github.com/textile -[13]: https://www.algolia.com/doc/api-reference/api-methods/set-settings/?language=ruby#set-settings -[14]: https://www.algolia.com/doc/javascript -[15]: https://github.com/algolia/hyde -[16]: https://travis-ci.org/ -[17]: https://travis-ci.org/ -[18]: http://docs.travis-ci.com/user/environment-variables/ -[19]: /docs/travis-settings.png -[20]: https://travis-ci.org -[21]: https://github.com/ayastreb/ -[22]: https://ayastreb.me/writing-a-jekyll-plugin/ +[7]: https://www.algolia.com/users/sign_up/hacker +[8]: https://www.algolia.com/licensing +[9]: https://github.com/ayastreb/ +[10]: https://ayastreb.me/writing-a-jekyll-plugin/