Skip to content

Commit

Permalink
Cleaning up and amending the README
Browse files Browse the repository at this point in the history
  • Loading branch information
karmi committed Apr 10, 2011
1 parent e92738b commit c192f59
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.markdown
Expand Up @@ -3,18 +3,19 @@ Hide


Search for [Jekyll](https://github.com/mojombo/jekyll) websites. Search for [Jekyll](https://github.com/mojombo/jekyll) websites.


Implemented for the <http://www.elasticsearch.org> website. Implemented for the <http://www.elasticsearch.org> website, may be useful for others.


Installation Installation
------------ ------------


1. Install [ElasticSearch](http://elasticsearch.org/guide/reference/setup/installation.html) 1. Install [ElasticSearch](http://elasticsearch.org/guide/reference/setup/installation.html)
2. Install the required gems: `bundle install` 2. Clone this repository: `git clone git://github.com/karmi/hide.git`
3. Install the required gems: `bundle install`


Usage Usage
----- -----


Clone the repository, such as: Clone the repository containing the Jekyll website, such as:


git clone https://github.com/elasticsearch/elasticsearch.github.com.git git clone https://github.com/elasticsearch/elasticsearch.github.com.git


Expand All @@ -30,5 +31,10 @@ Run the following Rake tasks:
rake index:import HIDE_WEBSITE=/path/to/the/cloned/website/repo rake index:import HIDE_WEBSITE=/path/to/the/cloned/website/repo


There's also a server serving as an endpoint for [Github post-receive hooks](http://help.github.com/post-receive-hooks/). There's also a server serving as an endpoint for [Github post-receive hooks](http://help.github.com/post-receive-hooks/).
You can run it as any Rack application, for example:


TODO: explain how to launch it. eg. bundle exec rackup bundle exec thin -R config.ru start

-----

[Karel Minarik](http://karmi.cz)

0 comments on commit c192f59

Please sign in to comment.