diff --git a/README.md b/README.md index 6b382bfc..649cd93b 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,20 @@ The `node-rdkafka` library is a high-performance NodeJS client for [Apache Kafka To view the reference docs for the current version, go [here](https://blizzard.github.io/node-rdkafka/current/) +## Contributing + +For guidelines on contributing please see [CONTRIBUTING.md](https://github.com/blizzard/node-rdkafka/blob/master/CONTRIBUTING.md) + +## Code of Conduct + +Play nice; Play fair. + +## Requirements + +* Apache Kafka >=0.9 +* Node.js >=4 +* Linux/Mac (Sorry Windows :() + ## Tests This project includes two types of unit tests in this project: @@ -24,13 +38,12 @@ This project includes two types of unit tests in this project: You can run both types of tests by using `Makefile`. Doing so calls `mocha` in your locally installed `node_modules` directory. +* Before you run the tests, be sure to init and update the submodules: + 1. `git submodule init` + 2. `git submodule update` * To run the unit tests, you can run `make lint` or `make test`. * To run the integration tests, you must have a running Kafka installation available. By default, the test tries to connect to `localhost:9092`; however, you can supply the `KAFKA_HOST` environment variable to override this default behavior. -## Contributing - -For guidelines on contributing please see [CONTRIBUTING.md](https://github.com/blizzard/node-rdkafka/blob/master/CONTRIBUTING.md) - # Usage You can install the `node-rdkafka` module like any other module: