aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..73c8c65
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# ηMatrix
+
+Definitely for advanced users.
+
+***
+
+## Install
+
+Right now, it can be installed only manually, either by building the
+XPI yourself or by downloading a pre-built XPI.
+
+### Building the XPI
+
+Clone the repository with git, then run `make all`.
+The XPI will be called `eMatrix.xpi`.
+
+### Downloading the pre-built XPI
+
+It's available [here](https://gitlab.com/vannilla/ematrix/tags)
+
+## Warning
+
+### Regarding broken sites
+
+ηMatrix will definitely break the majority of websites you visit.
+This add-on is meant for people that understand this and have enough
+knoweledge to understand what it needs to be done to "unbreak" those
+site.
+
+## Other
+
+For now, check the [μMatrix](https://github.com/gorhill/umatrix/)
+home.
+
+## License
+
+[GPLv3](LICENSE.txt)