Skip to content
This repository was archived by the owner on Jan 5, 2023. It is now read-only.

Commit eba9146

Browse files
Update readme for logging and few other minor fixes
1 parent 2ada64f commit eba9146

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -287,13 +287,16 @@ bokorServer/
287287
```
288288

289289
## Logs
290-
`====[ cache miss ]====`
290+
Bokor uses [Bunyan](https://github.com/trentm/node-bunyan) for logging. Bunyan is a simple and fast JSON logging library.
291+
Bunyan has many features. One of them allows pretty-printing of the log. We show this feature in the below [Demo From Source](#demo-from-source)
291292

292-
❤️ If the request does not find a prerecorded response it will log cache miss in the color red.
293+
`(cache=miss)`
293294

294-
`====[ cache hit ]====`
295+
❤️ If the request does not find a prerecorded response it will log cache miss.
295296

296-
💚 If the request finds a prerecorded response it will log cache hit in the color green.
297+
`(cache=hit)`
298+
299+
💚 If the request finds a prerecorded response it will log cache hit.
297300

298301
## Demo from Source
299302
Follow the below steps to run the Bokor Demo.
@@ -303,7 +306,7 @@ $ git clone https://github.com/Nike-Inc/bokor.git
303306
$ cd bokor
304307
$ npm install
305308
$ cd examples/source_example/
306-
$ node server.js
309+
$ node server.js | ../../node_modules/.bin/bunyan
307310
```
308311

309312
Record a response
@@ -320,20 +323,20 @@ $ curl http://localhost:7777/users/jimmyeisenhauer
320323
## Tests
321324

322325
```
323-
$ npm test
326+
$ npm run coverage
324327
```
325328

326329
## FAQ
327330
### Where did the name Bokor come from?
328331
It is a long story, but one of my favorite quotes is:
329332

330-
#####“any sufficiently advanced technology is indistinguishable from magic.”
333+
##### “any sufficiently advanced technology is indistinguishable from magic.”
331334

332335
-arthur c. clarke
333336

334337
So of course I penned a similar quote around test automation.
335338

336-
#####“software tests that unexplainably pass or fail are indistinguishable from voodoo.”
339+
##### “software tests that unexplainably pass or fail are indistinguishable from voodoo.”
337340
-james r. eisenhauer
338341

339342
And a Bokor is a voodoo sorcerer for hire who are said to serve the loa 'with both hands', practicing for both good and evil.

0 commit comments

Comments
 (0)