ShadowFox/README.md

![header](.github/Screenshots/header.png)

ShadowFox was inspired by changes made in Firefox 57, which limited the amount addons could customize both the user interface and "protected" web pages.

This project aims at creating a universal dark theme for Firefox while adhering to the modern design principles set by Mozilla.

You can visit the ShadowFox website at [overdodactyl.github.io/ShadowFox/](https://overdodactyl.github.io/ShadowFox/).

## Preview

![preferences](.github/Screenshots/preview.png)

ShadowFox styles the entire user interface, protected webpages (such as `about:` pages and addons.mozilla.org), and over 40 popular addons.

## Installation

1. Download the updater script from the [releases](https://github.com/SrKomodo/shadowfox-updater/releases) page of [shadowfox-updater](https://github.com/SrKomodo/shadowfox-updater) for your operating system and place it in a location you will remember for future use.

   * On Arch Linux, you can install the package [shadowfox-updater](https://aur.archlinux.org/packages/shadowfox-updater/) from AUR.

   * On MacOS, you can install using [Homebrew](https://brew.sh/)

   		- Install: `brew install srkomodo/tap/shadowfox-updater`
   		- Run: `shadowfox`

2. Run the script.

3. Restart Firefox.

For more detailed instructions, please see [here](https://github.com/overdodactyl/ShadowFox/wiki/Installation).

## Updating

Any time you want to update ShadowFox or apply custom changes, simply run the updater script again.  

## Customization

It's easy to customize ShadowFox, everything from the colors used to what elements and webpages are styled.  For more information, see [here](https://github.com/overdodactyl/ShadowFox/wiki/Customization).  

Depending on how much you want to customize ShadowFox, you may be better suited using a different installation process.  To learn more, see [here](https://github.com/overdodactyl/ShadowFox/wiki/Development).

## Discussion

* Chat about ShadowFox on Slack - [invitation link](https://join.slack.com/t/shadowfox-workspace/shared_invite/enQtMzI5Nzk5OTk1MjcxLThkMDgwOGE5ZDY1MDUyNjIwNWQ2MTlmMjEwZTJiZmZjYTUxODM4ZTRkNzhiNGRhZTFhMjdjMTFjMTQ3YjZjYzU)

## Find a bug? Have a feature request? Have any questions?

Please first read through the [wiki](https://github.com/overdodactyl/ShadowFox/wiki/) (including the getting started information, troubleshooting, and known problems) and take a look at any open [issues](https://github.com/overdodactyl/ShadowFox/issues).  If you can't find a duplicate request, bug, or an answer to your question, please feel free to either:

* Open a [new issue](https://github.com/overdodactyl/ShadowFox/issues/new)

* Make a post on the ShadowFox [Reddit page](https://www.reddit.com/r/ShadowFoxCSS/).


## Contributing

I welcome any contributions and would be excited to have a team of people helping with this project.  If you are uncomfortable making pull requests, you can simply open up an issue and attach any code you would like included.