Skip to content

Commit 1dc6b8e

Browse files
committed
Updated the main README
* Added a "Development" chapter and improved the instructions * Added Travis CI and Code Climate badges
1 parent a063458 commit 1dc6b8e

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

+16-5
Original file line numberDiff line numberDiff line change
@@ -132,15 +132,26 @@ Article.create title: 'Test'
132132
* [[Documentation]](http://rubydoc.info/gems/elasticsearch-rails)
133133
* [[Test Suite]](https://github.com/elasticsearch/elasticsearch-rails/blob/master/elasticsearch-rails/test)
134134

135-
## Running the Test Suite
135+
## Development
136+
137+
[![Build Status](https://travis-ci.org/elastic/elasticsearch-ruby.svg?branch=master)](https://travis-ci.org/elastic/elasticsearch-ruby) [![Code Climate](https://codeclimate.com/github/elastic/elasticsearch-ruby/badges/gpa.svg)](https://codeclimate.com/github/elastic/elasticsearch-ruby)
138+
139+
To work on the code, clone the repository and install all dependencies first:
140+
141+
```
142+
git clone https://github.com/elastic/elasticsearch-rails.git
143+
cd elasticsearch-rails/
144+
bundle install
145+
rake bundle:install
146+
```
147+
148+
### Running the Test Suite
136149

137150
You can run unit and integration tests for each sub-project by running the respective Rake tasks in their folders.
138151

139-
You can also unit, integration, or both tests in the top level directory for each sub-project:
152+
You can also unit, integration, or both tests for all sub-projects from the top-level directory:
140153

141-
rake bundle:clean
142-
rake bundle:install
143-
bundle exec rake test:all
154+
rake test:all
144155

145156
The test suite expects an Elasticsearch cluster running on port 9250, and **will delete all the data**. You can launch an isolated, in-memory Elasticsearch cluster with the following Rake task:
146157

0 commit comments

Comments
 (0)