Skip to content

Commit

Permalink
Update README with Requirements, CoC, and text cleanup (#3)
Browse files Browse the repository at this point in the history
* Add Requirements to README

* Add core value CoC to README

* Moved some sections around in README, fixed some grammar

* Update README requirements for linux/mac
  • Loading branch information
jordansirwin authored and webmakersteve committed Aug 13, 2016
1 parent c3c8344 commit 8a321b6
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down

0 comments on commit 8a321b6

Please sign in to comment.