fix: remove unused deps and update project config (#9)

maschad · Sep 21, 2022 · 2aa138f · 2aa138f
1 parent ce9f715
commit 2aa138f
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 26 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -6,3 +6,6 @@ updates:
     interval: daily
     time: "10:00"
   open-pull-requests-limit: 10
+  commit-message:
+    prefix: "deps"
+    prefix-development: "deps(dev)"
diff --git a/README.md b/README.md
@@ -1,20 +1,24 @@
-# libp2p-topology <!-- omit in toc -->
+# @libp2p/topology <!-- omit in toc -->
 
-[![test & maybe release](https://github.com/libp2p/js-libp2p-topology/actions/workflows/js-test-and-release.yml/badge.svg)](https://github.com/libp2p/js-libp2p-topology/actions/workflows/js-test-and-release.yml)
+[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
+[![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-topology.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-topology)
+[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-interfaces/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/libp2p/js-libp2p-topology/actions/workflows/js-test-and-release.yml)
 
-> Contains an implementation of the [Topology](https://github.com/libp2p/js-libp2p-interfaces/blob/master/packages/libp2p-interfaces/src/topology/index.ts) interface
+> libp2p network topology
 
 ## Table of contents <!-- omit in toc -->
 
-- [Installation](#installation)
+- [Install](#install)
 - [Usage](#usage)
 - [License](#license)
-  - [Contribution](#contribution)
+- [Contribute](#contribute)
 
-## Installation
+## Install
 
 ```console
-npm i @libp2p/topology
+$ npm i @libp2p/topology
 ```
 
 ## Usage
@@ -29,9 +33,9 @@ const topology = createTopology({ ... })
 
 Licensed under either of
 
- * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
- * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-### Contribution
+## Contribute
 
 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
@@ -3,13 +3,13 @@
   "version": "3.0.0",
   "description": "libp2p network topology",
   "license": "Apache-2.0 OR MIT",
-  "homepage": "https://github.com/libp2p/js-libp2p-pubsub-topology#readme",
+  "homepage": "https://github.com/libp2p/js-libp2p-topology#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/libp2p/js-libp2p-pubsub-topology.git"
+    "url": "git+https://github.com/libp2p/js-libp2p-topology.git"
   },
   "bugs": {
-    "url": "https://github.com/libp2p/js-libp2p-pubsub-topology/issues"
+    "url": "https://github.com/libp2p/js-libp2p-topology/issues"
   },
   "keywords": [
     "interface",
@@ -45,12 +45,12 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/src/index.js",
-      "types": "./dist/src/index.d.ts"
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
     },
     "./multicodec-topology": {
-      "import": "./dist/src/multicodec-topology.js",
-      "types": "./dist/src/multicodec-topology.d.ts"
+      "types": "./dist/src/multicodec-topology.d.ts",
+      "import": "./dist/src/multicodec-topology.js"
     }
   },
   "eslintConfig": {
@@ -86,15 +86,15 @@
               "release": "patch"
             },
             {
-              "type": "chore",
+              "type": "docs",
               "release": "patch"
             },
             {
-              "type": "docs",
+              "type": "test",
               "release": "patch"
             },
             {
-              "type": "test",
+              "type": "deps",
               "release": "patch"
             },
             {
@@ -124,7 +124,11 @@
               },
               {
                 "type": "docs",
-                "section": "Trivial Changes"
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
               },
               {
                 "type": "test",
@@ -148,14 +152,13 @@
     "release": "aegir release"
   },
   "dependencies": {
-    "@libp2p/interface-peer-id": "^1.0.2",
-    "@libp2p/interface-registrar": "^2.0.0",
-    "@libp2p/logger": "^2.0.0",
-    "@multiformats/multiaddr": "^10.2.0",
+    "@libp2p/interface-peer-id": "^1.0.4",
+    "@libp2p/interface-registrar": "^2.0.3",
+    "@libp2p/logger": "^2.0.1",
     "err-code": "^3.0.1",
     "it-all": "^1.0.6"
   },
   "devDependencies": {
-    "aegir": "^37.0.7"
+    "aegir": "^37.5.3"
   }
 }