summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <yuval@y3xz.com>2016-04-03 23:55:49 +0300
committerYuval Adam <yuval@y3xz.com>2016-04-03 23:55:49 +0300
commitbcc864f3ff2487b880ee66dd4e8decbcec7a03c9 (patch)
tree34a907c391471f619b9fdac23986074d83d4dee3 /README.md
parentf312e9ad94b4b53aa032c90e3f54cbbd9aa777e5 (diff)
Unified README
Diffstat (limited to 'README.md')
-rw-r--r--README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..ebee555 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,54 @@
+# Free Haaretz
+
+A nefarious browser extension that easily bypasses the Haaretz paywall.
+
+If things aren't working as expected, make sure to reinstall (update) the extension from time to time, to make sure you have the latest code.
+
+## Install
+
+Installation has to be done manually. I'm not interested in distributing this extension in the Mozilla / Google addon 'stores'.
+
+### Firefox
+
+ 1. Download the [add-on XPI file](https://github.com/yuvadm/free-haaretz/raw/master/free-haaretz.xpi)
+
+ 2. Go to the `Tools > Add-ons` menu
+
+ 3. Click the ⚙ button on the top
+
+ 4. Choose `Install Add-on From File`
+
+ 5. Select the XPI file you downloaded
+
+ 6. Click `Install Now`
+
+### Chrome / Chromium
+
+ 1. Download the [extension ZIP file](https://github.com/yuvadm/free-haaretz/archive/master.zip), also located on the right side bar.
+
+ 2. Unzip the file.
+
+ 3. In Google Chrome (or Chromium), in the address bar go to [chrome://extensions](chrome://extensions)
+
+ 4. In the top right corner, click to enable **Developer Mode**.
+
+ 5. Click the **Load unpacked extension** button.
+
+ 6. Navigate to the folder you unziped your code to, and select it.
+
+ 7. The **FreeHaaretz** extension should now be loaded
+
+## Troubleshooting
+
+Things not working? Follow these steps:
+
+ - Make sure you're running the latest version
+ - Clean your browser cache and cookies
+
+Noticed a bug? Open an issue.
+
+## License
+
+This code is in the Public Domain, do whatever you want with it, I'm not responsible.
+
+![Public Domain](https://i.creativecommons.org/p/mark/1.0/88x31.png)