Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
OrionReed committed Mar 28, 2024
1 parent 6d8750f commit a714951
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,31 @@
## dom3d

A 3D DOM viewer for Firefox, Chrome, and Safari

**NOTE: Only tested in Firefox so far. Help with cross-browser support is welcome.**
**NOTE: Only tested in Firefox and Chrome so far. Help with cross-browser support is welcome.**

## Install
From your browser, enable developer mode (or equivelant) and install the extension from the `dist` folder.
Download the latest [release](https://github.com/OrionReed/dom3d/releases) and unzip the file.

**In Firefox**
1. Go to `about:debugging#/runtime/this-firefox`
2. Click "Load Temporary Addon"
3. Select `dom3d/dist/firefox/manifest.json`
3. Select `manifest.json` in the downloaded folder
4. Extension should now be installed, you can find it in the top right extensions menu (puzzle piece icon) and pin it if desired

**In Chrome**
1. Go to `chrome://extensions`
2. Click "Load Unpacked"
3. Select the folder `dom3d/dist/chrome/`
3. Select the downloaded folder
4. Extension should now be installed, you can find it in the top right extensions menu (puzzle piece icon) and pin it if desired

## Usage
- Click extension icon to toggle 3D DOM view
- Right-Click for options (showing sides, surfaces, randomising color, and enabling zoom)
- Click the extension icon to toggle 3D DOM view
- Right-Click for options like showing sides, surfaces, randomising color, and enabling zoom.

## Development
`yarn build-all` to build all the versions of the extension. You can use [web-ext](https://github.com/mozilla/web-ext) to help develop for Firefox.
1. Run `yarn install`
2. Run `yarn watch` to watch for changes and automatically rebuild the extension, or one of the `build:{browser}` scripts to build a specific browser.
3. Load the extension from `dist/{browser}` following the steps above.

You can use [web-ext](https://github.com/mozilla/web-ext) to reload the extension in Firefox automatically. Chrome requires a manual reload from the `chrome://extensions` page.

0 comments on commit a714951

Please sign in to comment.