fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-04-24 18:02:28 +00:00
Code Issues Projects Releases Wiki Activity

docs: update discovery tests usage (#61)

Browse Source
This commit is contained in:
Vasco Santos 2020-08-17 18:10:55 +02:00 committed by GitHub
parent a60ae091e5
commit d6376377d3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
src/peer-discovery/README.md
View File

@ -33,19 +33,19 @@ Include this badge in your readme if you make a new module that uses interface-p
Install `interface-discovery` as one of the dependencies of your project and as a test file. Then, using `mocha` (for JavaScript) or a test runner with compatible API, do:
```js
const test = require('interface-discovery')
const tests = require('libp2p-interfaces/src/peer-discovery/tests')
const common = {
setup () {
return YourDiscovery
},
teardown () {
// Clean up any resources created by setup()
}
}
// use all of the test suits
test(common)
describe('your discovery', () => {
// use all of the test suits
tests({
setup () {
return YourDiscovery
},
teardown () {
// Clean up any resources created by setup()
}
})
})
```
## API