diff --git a/.gitignore b/.gitignore index aaa4b61..9a3cb9f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,27 +1,7 @@ -# Logs -logs -*.log - -# Runtime data -pids -*.pid -*.seed - -# Directory for instrumented libs generated by jscoverage/JSCover -lib-cov - -# Coverage directory used by tools like istanbul -coverage -.coverage -.nyc_output - -# Dependency directory -# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git node_modules - -lib dist - +.docs +.coverage +node_modules package-lock.json yarn.lock -.cache diff --git a/README.md b/README.md index 209c498..b48323a 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/) [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io) [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-prometheus-metrics.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-prometheus-metrics) -[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-prometheus-metrics/test%20&%20maybe%20release/main?style=flat-square)](https://github.com/libp2p/js-libp2p-prometheus-metrics/actions/workflows/js-test-and-release.yml) +[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-prometheus-metrics/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/libp2p/js-libp2p-prometheus-metrics/actions/workflows/js-test-and-release.yml?query=branch%3Amain) > Collect libp2p metrics for scraping by Prometheus or Graphana @@ -17,8 +17,9 @@ - [Memory usage](#memory-usage) - [DHT query time](#dht-query-time) - [TCP transport dialer errors](#tcp-transport-dialer-errors) +- [API Docs](#api-docs) - [License](#license) -- [Contribute](#contribute) +- [Contribution](#contribution) ## Install @@ -80,6 +81,10 @@ or rate(libp2p_tcp_dialer_errors_total[30s]) +## API Docs + +- + ## License Licensed under either of @@ -87,6 +92,6 @@ Licensed under either of - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) - MIT ([LICENSE-MIT](LICENSE-MIT) / ) -## Contribute +## Contribution Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. diff --git a/package.json b/package.json index 0d2cc19..da5d38b 100644 --- a/package.json +++ b/package.json @@ -20,7 +20,7 @@ "types": "./dist/src/index.d.ts", "files": [ "src", - "dist/src", + "dist", "!dist/test", "!**/*.tsbuildinfo" ], @@ -129,7 +129,8 @@ "test": "aegir test -t node", "test:node": "aegir test -t node --cov", "test:electron-main": "aegir test -t electron-main --cov", - "release": "aegir release" + "release": "aegir release", + "docs": "aegir docs" }, "dependencies": { "@libp2p/interface-connection": "^3.0.2", @@ -139,7 +140,7 @@ "it-stream-types": "^1.0.4" }, "devDependencies": { - "@libp2p/interface-mocks": "^7.0.3", + "@libp2p/interface-mocks": "^8.0.4", "@libp2p/peer-id-factory": "^1.0.19", "@multiformats/multiaddr": "^11.0.7", "aegir": "^37.5.6",