Skip to content

Commit

Permalink
readme and eslint
Browse files Browse the repository at this point in the history
  • Loading branch information
OronNadiv committed Jul 15, 2016
1 parent f6dfa92 commit a46c514
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
4 changes: 4 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
"extends": "standard",
"plugins": [
"promise",
"standard"
],
"globals": {
"describe": false,
"it": false,
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
#BFS as Promised — Promisified Breadth-First SearchFinder.
#BFS as Promised — Promisified Breadth-First Search.

[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Test Coverage][coveralls-image]][coveralls-url]
[![Dependencies][dependencies-image]][dependencies-url]
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

Asynchronous implementation of [BFS][bfs] to find the shortest path. The implementation uses [Bluebird][bluebird]'s promise.

Expand Down Expand Up @@ -72,11 +73,11 @@ E.g. for the following graph:
2 -> 4
4 -> 5
```
Calling `find()` where start node is `1` and goal node is `5`, will return a promise that once resolved, it will returns `[1, 2, 4, 5]`.
<br/>Calling `find()` where start node is `1` and goal node is `-1`, will return a promise that once resolved, it will returns `null`.
Calling `find()` where start node is `1` and goal node is `5`, will return a promise that, once resolved, it will returns `[1, 2, 4, 5]`.
<br/>Calling `find()` where start node is `1` and goal node is `-1`, will return a promise that, once resolved, it will returns `null`.

## License
MIT
[MIT](https://tldrlegal.com/license/mit-license)

[npm-image]: https://img.shields.io/npm/v/bfs-as-promised.svg?style=flat-square
[npm-url]: https://npmjs.org/package/bfs-as-promised
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "bfs-as-promised",
"version": "1.0.3",
"version": "1.0.4",
"description": "Breadth-first search (BFS) using promise (Bluebird)",
"main": "lib/bfs.js",
"keywords": [
Expand All @@ -26,7 +26,7 @@
"compile": "babel src --out-dir lib --source-maps --minified",
"test-coveralls": "istanbul cover _mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js && rm -rf ./coverage",
"cover": "istanbul cover _mocha --include-all-sources -x **/lib/**",
"lint": "eslint src --ignore-path .gitignore",
"lint": "eslint src test",
"test": "mocha && npm run lint"
},
"devDependencies": {
Expand Down

0 comments on commit a46c514

Please sign in to comment.