Skip to content

Commit 407e818

Browse files
committed
build and install instructions update
1 parent 9686b6b commit 407e818

1 file changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
A Google Chrome developer tools extension for use by [Solidus](https://github.com/solidusjs/solidus) developers. Provides real-time introspection of API data and access to Solidus server error logs for use in debugging preprocessors executed in the Node.js runtime environment.
22

3-
**Note:** This is still a work in progress, use at your own risk.
4-
5-
#Build
3+
#Clone
64
* Clone the repo with `git clone https://github.com/solidusjs/devtools-solidus.git devtools-solidus`
7-
* Run `npm install` to install dependencies (npm will automatically run a script to install front-end dependencies using bower).
8-
* (Optional) Chrome will complain about `.pem` files in some of the dependencies, so you can manually delete `node_modules/socket.io-client/node_modules/engine.io-client/node_modules/ws/test/` to prevent Chrome from warning you when you install the extension.
95

106
#Installation
11-
* Open chrome://extensions
12-
* Enable 'Developer Mode' checkbox
13-
* Click 'Load unpacked extensions...'
14-
* Select the `devtools-solidus` folder
7+
* Find the `.crx` file you want in the `dist/` directory. We recommend using the latest version, or you can manually build your own (see below).
8+
* Open <chrome://extensions> in Chrome
9+
* Drag and drop the `.crx` file onto the page and click "Add" to install.
10+
11+
#Manually Build
12+
* Run `npm install` to install dependencies (npm will automatically run a script to install front-end dependencies using bower).
13+
* Run `grunt build` to generate an installable `.crx` file in the `dist/` directory.
14+
15+
#Usage
16+
* Once the extension is installed, you can open Chrome's Developer Tools and you should see a "Solidus" tab.

0 commit comments

Comments
 (0)