Update README

gtback · Jul 26, 2020 · 4ceef27 · 4ceef27
1 parent a3a5f12
commit 4ceef27
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+web-ext-artifacts/*
diff --git a/README.md b/README.md
@@ -1,2 +1,32 @@
 # private-github-header
+
 Web Extension to modify the GitHub header for private repos
+
+For people who frequently work in both private and public GitHub repositories,
+this provides a clear visual distinction between the two.
+
+**Public repos**:
+
+![Public repos](public.png)
+
+**Private repos**:
+
+![Private repos](private.png)
+
+## Developing
+
+Use the [`web-ext`](https://github.com/mozilla/web-ext) tool to develop, test,
+and build this extension.
+
+```sh
+npm install -g web-ext
+
+web-ext run
+
+web-ext lint
+
+web-ext build
+```
+
+For now I've been manually uploading the extension to addons.mozilla.org rather
+than trying to set up `web-ext sign`.
diff --git a/private.png b/private.png
diff --git a/public.png b/public.png