go-ipfs - npm Package Compare versions

Comparing version 0.7.0 to 0.8.0-rc1

package.json

 {
   "name": "go-ipfs",
-  "version": "0.7.0",
+  "version": "0.8.0-rc1",
   "description": "Install the latest go-ipfs binary",
@@ -5,0 +5,0 @@ "main": "src/index.js",

README.md

@@ -22,12 +22,4 @@ # npm-go-ipfs
 
-Install the latest [go-ipfs](https://github.com/ipfs/go-ipfs/) binary.
+Install the latest [go-ipfs](https://github.com/ipfs/go-ipfs/) binary:
 
-```
-npm install -g go-ipfs
-```
-
-Installs from [https://gobuilder.me/github.com/ipfs/go-ipfs/cmd/ipfs](https://gobuilder.me/github.com/ipfs/go-ipfs/cmd/ipfs).
-
-## Usage
-
 ```sh
@@ -37,3 +29,3 @@ # Install globally
 > ipfs version
-ipfs version v0.4.22
+ipfs version v0.7.0
 
@@ -43,9 +35,21 @@ # Install locally
 > ./node_modules/.bin/ipfs
-ipfs version v0.4.22
+ipfs version v0.7.0
 ```
 
-See [IPFS getting-started](http://ipfs.io/docs/getting-started). If anything goes wrong, try using: [http://ipfs.io/docs/install](http://ipfs.io/docs/install).
+## Usage
 
-**Warning:** this module uses the _latest_ version of ipfs. If there is a strong need to vendor an older version, let us know. We care about versions very much :(  but for a number of reasons, this is easier for us all right now.
+This module downloads `go-ipfs` binaries from https://dist.ipfs.io into your project.
 
+It will download the go-ipfs version that matches the npm version of this module. So depending on `go-ipfs@0.7.0` will install `go-ipfs v0.7.0` for your current system architecture, in to your project at `node_modules/go-ipfs/go-ipfs/ipfs` and additional symlink to it at `node_modules/go-ipfs/bin/ipfs`.
+
+After downloading you can find out the path of the installed binary by calling the `path` function exported by this module:
+
+```javascript
+const { path } = require('go-ipfs')
+
+console.info('go-ipfs is installed at', path())
+```
+
+An error will be thrown if the path to the binary cannot be resolved.
+
 ## Development
@@ -52,0 +56,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21151

increased by0.69%

Number of lines in readme file

111

increased by3.74%

No dependency changes