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 and Updating

A cross-platform installer/uninstaller/updater is maintained in the [shadowfox-updater](https://github.com/SrKomodo/shadowfox-updater) repository.  Latest versions can be found in the [releases](https://github.com/SrKomodo/shadowfox-updater/releases) section, or via `Homebrew`, `MacPorts`, and `AUR`.  Please see the [README](https://github.com/SrKomodo/shadowfox-updater/blob/master/README.md) file for details on how to use the updater (GUI and CLI options available) and solutions to common problems.

## Customization

It's easy to customize ShadowFox.  You can choose what colors are used, what elements and webpages are styled, or add your own css tweaks.  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/enQtMzU3NTU2NTQ0NDA1LTcwN2I1M2I4MzlkMWFlMWEzODc2MTY1NzU2NjhlYTgzOGY5ZTQzM2UxZTFiZDMxNDM1NDMyNjlhOWQ4MWQ3ZDc)

## 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.
restructure repo 2018-03-11 21:58:02 +00:00			`![header](.github/Screenshots/header.png)`
Update README.md 2017-12-18 23:06:06 +00:00
Update README.md 2018-02-27 21:16:38 +00:00			`ShadowFox was inspired by changes made in Firefox 57, which limited the amount addons could customize both the user interface and "protected" web pages.`
Update README.md 2017-12-18 23:06:06 +00:00
Update README 2018-02-26 23:34:16 +00:00			`This project aims at creating a universal dark theme for Firefox while adhering to the modern design principles set by Mozilla.`
Update README.md 2017-12-18 23:06:06 +00:00
Add website link to README.md 2018-06-10 06:54:59 +00:00			`You can visit the ShadowFox website at [overdodactyl.github.io/ShadowFox/](https://overdodactyl.github.io/ShadowFox/).`

Update README 2018-02-26 23:34:16 +00:00			`## Preview`
Update README.md 2017-12-18 23:06:06 +00:00
restructure repo 2018-03-11 21:58:02 +00:00			`![preferences](.github/Screenshots/preview.png)`
Update README.md 2017-12-18 23:06:06 +00:00
Update README.md 2018-04-22 05:10:19 +00:00			ShadowFox styles the entire user interface, protected webpages (such as `about:` pages and addons.mozilla.org), and over 40 popular addons.
Update README.md 2017-12-18 23:06:06 +00:00
point users to README file in updater repo 2018-09-27 00:05:11 +00:00			`## Installation and Updating`
Update README.md 2017-12-18 23:06:06 +00:00
make mention of installation via MacPorts in the README 2019-01-24 21:42:44 +00:00			A cross-platform installer/uninstaller/updater is maintained in the [shadowfox-updater](https://github.com/SrKomodo/shadowfox-updater) repository. Latest versions can be found in the [releases](https://github.com/SrKomodo/shadowfox-updater/releases) section, or via `Homebrew`, `MacPorts`, and `AUR`. Please see the [README](https://github.com/SrKomodo/shadowfox-updater/blob/master/README.md) file for details on how to use the updater (GUI and CLI options available) and solutions to common problems.
Update README.md 2017-12-08 05:25:44 +00:00
Update README 2018-02-26 23:34:16 +00:00			`## Customization`
Update README.md 2017-12-02 04:55:47 +00:00
update README #158 2019-03-03 17:08:56 +00:00			`It's easy to customize ShadowFox. You can choose what colors are used, what elements and webpages are styled, or add your own css tweaks. For more information, see [here](https://github.com/overdodactyl/ShadowFox/wiki/Customization).`
update README 2018-04-22 01:34:45 +00:00
			`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).`
Update README.md 2017-12-02 04:55:47 +00:00
Add Slack link 2018-03-13 02:31:13 +00:00			`## Discussion`
Addon AMO screenshot to README.md 2017-12-08 08:21:06 +00:00
update slack invitation 2018-10-04 19:42:28 +00:00			`* Chat about ShadowFox on Slack - [invitation link](https://join.slack.com/t/shadowfox-workspace/shared_invite/enQtMzU3NTU2NTQ0NDA1LTcwN2I1M2I4MzlkMWFlMWEzODc2MTY1NzU2NjhlYTgzOGY5ZTQzM2UxZTFiZDMxNDM1NDMyNjlhOWQ4MWQ3ZDc)`
Add Slack link 2018-03-13 02:31:13 +00:00
			`## Find a bug? Have a feature request? Have any questions?`
Update README.md 2017-12-22 19:24:02 +00:00
Update README 2018-02-26 23:34:16 +00:00			`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:`
Update README.md 2017-12-22 19:24:02 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* Open a [new issue](https://github.com/overdodactyl/ShadowFox/issues/new)`
Add compatibility for webextension chages 2017-11-30 02:26:03 +00:00
Update README 2018-02-26 23:34:16 +00:00			`* Make a post on the ShadowFox [Reddit page](https://www.reddit.com/r/ShadowFoxCSS/).`
Add compatibility for webextension chages 2017-11-30 02:26:03 +00:00
Variable replacement 1 2018-02-22 05:20:30 +00:00
Add Slack link 2018-03-13 02:31:13 +00:00			`## Contributing`
Add compatibility for webextension chages 2017-11-30 02:26:03 +00:00
Update README.md 2017-12-18 23:32:42 +00:00			`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.`