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

Commit 55bfc48

Browse files
committed
docs: update electron example
1 parent 30bd19c commit 55bfc48

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

examples/electron/README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# js-ipfs in Electron
22

3-
This example is heavily inspired by [electron-quick-start](https://github.com/electron/electron-quick-start).
3+
> This example is heavily inspired by [electron-quick-start](https://github.com/electron/electron-quick-start).
44
5-
Simply `npm install` and `npm start` to see it working.
5+
**DISCLAIMER:** This example is still a work in progress, it currently doesn't work due to the usage of native dependencies that Electron is not supporting.
6+
7+
To try it by yourself, do:
8+
9+
```
10+
> npm install
11+
> ./node_modules/.bin/electron-rebuild
12+
# You can also try to use npm start to see where electron errors
13+
```

examples/electron/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@
1717
"devDependencies": {
1818
"electron": "~1.6.11",
1919
"electron-rebuild": "^1.5.11",
20-
"ipfs": "ipfs/js-ipfs#feat\/no-wrtc-by-default"
20+
"ipfs": "ipfs/js-ipfs"
2121
}
2222
}

0 commit comments

Comments
 (0)