aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 38 insertions, 1 deletions
diff --git a/README.md b/README.md
index ccfe236..45444ea 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,38 @@
-# firefoxer
+# Firefoxer
+
+## About
+
+This repository has utilities and customizations for [Mozilla
+Firefox](https://www.mozilla.org/en-US/firefox/).
+
+Inspired by:
+
+* [Timvde/UserChrome-Tweaks: A community maintained repository of userChrome.css tweaks for Firefox](https://github.com/Timvde/UserChrome-Tweaks)
+
+## Conventions
+
+## Profiles
+
+* It's suggested to store profiles in the `~/.mozilla/firefox/profiles`.
+
+### Shared useChrome.css
+
+There are many ways to reuse the same `userChrome` configuration among all your
+profiles:
+
+ cd ~/.mozilla/firefox/profiles
+ for file in *; do
+ ln -sf /path/to/firefoxer/chrome $file/chrome;
+ done
+
+### Suggested profiles
+
+* `template`:
+ * Useful to be the base for new templates.
+ * New templates are copied from this one by the
+ [firefox-profile](firefox-profile) script, but once they're copied, they're
+ effective _forked_.
+* `editor`:
+ * Usesful for editing bookmarks and moving them from one profile to another.
+* `regular`:
+ * Usesul a regular connection (i.e, not proxied through the Tor Network).