Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 1e95c0f

Browse files
committed
docs: simplify install section
1 parent 69162e8 commit 1e95c0f

File tree

1 file changed

+6
-13
lines changed

1 file changed

+6
-13
lines changed

README.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ You can check the development status at the [Waffle Board](https://waffle.io/ipf
5252
- [npm](#npm)
5353
- [Use in Node.js](#use-in-nodejs)
5454
- [Through command line tool](#through-command-line-tool)
55-
- [Use in the browser with browserify, webpack or any bundler](#use-in-the-browser-with-browserify-webpack-or-any-bundler)
56-
- [Use in a browser using a script tag](#use-in-a-browser-using-a-script-tag)
55+
- [Use in the browser](#use-in-the-browser)
5756
- [Usage](#usage)
5857
- [CLI](#cli)
5958
- [HTTP-API](#http-api)
@@ -82,7 +81,7 @@ You can check the development status at the [Waffle Board](https://waffle.io/ipf
8281

8382
## Install
8483

85-
This project is available through [npm](https://www.npmjs.com/). To install:
84+
This project is available through [npm](https://www.npmjs.com/). To install run
8685

8786
```bash
8887
> npm install ipfs --save
@@ -112,20 +111,14 @@ The CLI is available by using the command `jsipfs` in your terminal. This is ali
112111

113112
### Use in the browser
114113

115-
##### With browserify, webpack or any bundler
114+
Learn how to bundle with browserify and webpack in the [`examples`](https://github.com/ipfs/js-ipfs/tree/master/examples) folder.
116115

117-
Find examples of how to do this bundling at: `https://github.com/ipfs/js-ipfs/tree/master/examples`. If you are using webpack, make sure to use version 2 or above, otherwise it won't work.
118116

119-
##### With script tag
120-
121-
Loading this module in a browser (using a `<script>` tag) makes the `Ipfs` object available in the global namespace. The last published version of the package become [available for download](https://unpkg.com/ipfs/dist/) from [unpkg](https://unpkg.com/) and thus you may use it as the source:
117+
You can also load it using a `<script>` using the [unpkg](https://unpkg.com) CDN. Inserting one of the following lines will make a `Ipfs` object available in the global namespace.
122118

123119
```html
124-
<!-- loading the minified version -->
125-
<script src="https://unpkg.com/ipfs/dist/index.min.js"></script>
126-
127-
<!-- loading the human-readable (not minified) version -->
128-
<script src="https://unpkg.com/ipfs/dist/index.js"></script>
120+
<script src="https://unpkg.com/ipfs/dist/index.min.js"></script> <!-- loading the minified version -->
121+
<script src="https://unpkg.com/ipfs/dist/index.js"></script> <!-- loading the human-readable (not minified) version -->
129122
```
130123

131124
## Usage

0 commit comments

Comments
 (0)