@libp2p/daemon 1.0.3 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +33 -17
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,28 +1,37 @@
1
- libp2p-daemon JavaScript implementation
2
- ======
1
+ # @libp2p/daemon <!-- omit in toc -->
3
2
 
4
- <a href="http://libp2p.io/"><img src="https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square" /></a>
5
- <a href="http://webchat.freenode.net/?channels=%23libp2p"><img src="https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square" /></a>
6
- <a href="https://discuss.libp2p.io"><img src="https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg" /></a>
7
- <a href="https://waffle.io/libp2p/libp2p"><img src="https://img.shields.io/badge/pm-waffle-yellow.svg?style=flat-square" /></a>
3
+ [![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
4
+ [![IRC](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
5
+ [![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
6
+ [![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-daemon.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-daemon)
7
+ [![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-daemon/actions/workflows/js-test-and-release.yml)
8
8
 
9
- > A standalone deployment of a libp2p host, running in its own OS process and installing a set of virtual endpoints to enable co-local applications to: communicate with peers, handle protocols, interact with the DHT, participate in pubsub, etc. no matter the language they are developed in, nor whether a native libp2p implementation exists in that language.
9
+ > libp2p-daemon JavaScript implementation
10
10
 
11
- ## Lead Maintainer
11
+ ## Table of contents <!-- omit in toc -->
12
12
 
13
- [Jacob Heun](https://github.com/jacobheun)
13
+ - [Install](#install)
14
+ - [Specs](#specs)
15
+ - [Usage](#usage)
16
+ - [Contribute](#contribute)
17
+ - [License](#license)
18
+ - [Contribution](#contribution)
19
+
20
+ ## Install
21
+
22
+ ```console
23
+ $ npm i @libp2p/daemon
24
+ ```
14
25
 
15
26
  ## Specs
16
27
 
17
28
  The specs for the daemon are currently housed in the go implementation. You can read them at [libp2p/go-libp2p-daemon](https://github.com/libp2p/go-libp2p-daemon/blob/master/specs/README.md)
18
29
 
19
- ## Install
30
+ ## Usage
20
31
 
32
+ ```console
33
+ $ jsp2pd --help
21
34
  ```
22
- npm i -g libp2p-daemon
23
- ```
24
-
25
- ## Usage
26
35
 
27
36
  For a full list of options, you can run help `jsp2pd --help`.
28
37
  Running the defaults, `jsp2pd`, will start the daemon and bind it to a local unix socket path.
@@ -30,8 +39,8 @@ Daemon clients will be able to communicate with the daemon over that unix socket
30
39
 
31
40
  As an alternative, you can use this daemon with a different version of libp2p as the one specified in `package.json`. You just need to define its path through an environment variable as follows:
32
41
 
33
- ```sh
34
- export LIBP2P_JS=./../../js-libp2p/src/index.js
42
+ ```console
43
+ $ LIBP2P_JS=/path/to/js-libp2p/src/index.js jsp2pd
35
44
  ```
36
45
 
37
46
  ## Contribute
@@ -40,4 +49,11 @@ This module is actively under development. Please check out the issues and submi
40
49
 
41
50
  ## License
42
51
 
43
- MIT © Protocol Labs
52
+ Licensed under either of
53
+
54
+ - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
55
+ - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
56
+
57
+ ## Contribution
58
+
59
+ 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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/daemon",
3
- "version": "1.0.3",
3
+ "version": "2.0.1",
4
4
  "description": "libp2p-daemon JavaScript implementation",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/libp2p/js-libp2p-daemon/tree/master/packages/libp2p-daemon#readme",
@@ -31,6 +31,7 @@
31
31
  ],
32
32
  "exports": {
33
33
  ".": {
34
+ "types": "./src/index.d.ts",
34
35
  "import": "./dist/src/index.js"
35
36
  }
36
37
  },
@@ -131,15 +132,14 @@
131
132
  "release": "aegir release"
132
133
  },
133
134
  "dependencies": {
134
- "@libp2p/daemon-server": "^1.0.0",
135
- "@libp2p/interfaces": "^2.0.1",
135
+ "@libp2p/daemon-server": "^2.0.0",
136
136
  "@multiformats/multiaddr": "^10.1.8",
137
137
  "es-main": "^1.0.2",
138
138
  "yargs": "^17.3.1",
139
139
  "yargs-promise": "^1.1.0"
140
140
  },
141
141
  "devDependencies": {
142
- "aegir": "^37.0.5",
142
+ "aegir": "^37.2.0",
143
143
  "sinon": "^14.0.0"
144
144
  }
145
145
  }