diff --git a/README.md b/README.md index ce31d54..2ba6c08 100644 --- a/README.md +++ b/README.md @@ -81,14 +81,17 @@ Records API Run tests --------- -Start a redis server on the default port -```bash -redis-server ./conf/redis.conf -``` - Run the tests with mocha: ```bash -make test +npm run redis_start +npm test +npm run redis_stop ``` +Note, the command above use a Docker container. You can use you're own Redis server by only running `npm test` after modifying the configuration file located in "conf/test.coffee". + +If Redis is installed, start a redis server on the default port: +`redis-server ./conf/redis.conf` +If Docker is installed, start a container: +`docker run --name ron -p 6379:6379 -d redis redis-server --appendonly yes` diff --git a/package.json b/package.json index f152974..190ba0e 100644 --- a/package.json +++ b/package.json @@ -31,6 +31,8 @@ "engines": { "node": ">= 0.4.0" }, "scripts": { "coffee": "coffee -b -o lib src", + "redis_start": "docker run --name ron -p 6379:6379 -d redis", + "redis_stop": "docker rm -f ron", "pretest": "cp -n conf/test.coffee.sample conf/test.coffee; coffee -b -o lib src", "test": "mocha" }