You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+35-2
Original file line number
Diff line number
Diff line change
@@ -50,10 +50,43 @@ IPFS repo exposes a well defined interface by the Repo Spec. Each of the individ
50
50
- The blocks folder is the current version of datastore.
51
51
- The keys repo doesn't exist yet, as the private key is simply stored inside config
52
52
53
-
## Usage
53
+
# Installation
54
+
55
+
## npm
56
+
57
+
```sh
58
+
> npm i ipfs-repo
59
+
```
60
+
61
+
## Use in Node.js
62
+
63
+
```JavaScript
64
+
var IPFSRepo =require('ipfs-repo')
65
+
```
66
+
67
+
## Use in a browser with browserify, webpack or any other bundler
68
+
69
+
The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.
70
+
71
+
```JavaScript
72
+
var IPFSRepo =require('ipfs-repo')
73
+
```
74
+
75
+
## Use in a browser Using a script tag
76
+
77
+
Loading this module through a script tag will make the `Unixfs` obj available in the global namespace.
0 commit comments