Merge pull request #11 from Rayquaza01/feature

Feature

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+end_of_line = lf
+
+[*.{json,html,css}]
+indent_size = 2

.eslintrc.json

@@ -0,0 +1,21 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "rules": {
+    "indent": ["error", 4, { "SwitchCase": 1 }],
+    "quotes": ["warn", "double"],
+    "semi": ["warn", "always"],
+    "eqeqeq": ["error", "always"],
+    "no-trailing-spaces": "warn",
+    "comma-spacing": "warn",
+    "no-nested-ternary": "warn",
+    "max-depth": ["warn", 4]
+  }
+}

.gitattributes

@@ -0,0 +1,11 @@
+* text=auto
+
+*.ts text eol=lf
+*.js text eol=lf
+*.json text eol=lf
+*.html text eol=lf
+*.css text eol=lf
+*.svg text eol=lf
+*.md text eol=lf
+
+*.png binary

.github/FUNDING.yml

@@ -1,7 +1,7 @@
 # These are supported funding model platforms
 
 github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: Rayquaza01
+patreon: #
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel

.gitignore

@@ -2,3 +2,6 @@
 *.swo
 Thumbs.db
 web-ext-artifacts/
+
+dist/
+node_modules/

BUILD.md

@@ -0,0 +1,29 @@
+# Build Instructions for Changelogger 1.1.0
+
+## Environment
+
+ * Ubuntu 20.10
+ * node v14.16.0
+ * npm 6.14.11
+ * Tool and library versions in package.json
+
+# Production
+
+To build for production:
+
+```
+# install node module dependencies
+npm install
+
+# build production
+npm run build:production
+
+# build extension zip
+npm run build:extension
+```
+
+The final output file will be `./web-ext-artifacts/changelogger-1.1.0.zip`.
+
+# Development
+
+The command `npm run build:development` will run the build in development and watch mode. It will (re)build to `./dist` on file changes.

README.md

@@ -1,25 +1,39 @@
 # changelogger
 A Firefox extension that gets changelogs for other Firefox extensions.
 
-How to use:
+[![](https://img.shields.io/github/v/release/Rayquaza01/changelogger?label=github)](https://github.com/Rayquaza01/changelogger)
+[![](https://img.shields.io/amo/v/changelogger)](https://addons.mozilla.org/en-US/firefox/addon/changelogger/)
+
+## How to use:
  1. Install Changelogger.
  2. Wait for extensions to update or install new extensions.
  3. When an extension updates, Changelogger will fetch its changelog and place it in the popup.
 
-Options:
- * Badge (True or False) - whether to display a badge on the toolbar icon when an extension updates.
+## Options:
+ * Badge (True or False) - Should the icon badge be shown when an extension is updated?
  * Notification (True or False) - whether to create a notification when an extension updates.
- * Max (number) - How many changelogs to save at a time
- * Theme (Light or Dark) - whether to use a light or dark theme
- * Ignore updates without changelogs - whether to ignore updates that don't have changelogs
+ * Max (number) - Max number of changelogs to store at once.
+ * Ignore updates without changelogs (True or False) - Should updates with no changelogs be ignored?
+
+The colorscheme will be automatically set (light or dark) based on your operating system's colorscheme setting.
 
-Permissions:
+## Permissions:
  * management - required to detect when any extension updates
  * storage - required to save changelogs
  * notifications - required to notify user when any extension updates
- * https://addons.mozilla.org/api/v3/addons/addon/\* - required to fetch changelog from addons.mozilla.org API
- * webRequest - required to make web request to AMO API
+ * https://addons.mozilla.org/api/v4/addons/addon/\* - required to fetch changelog from addons.mozilla.org API
+
+## What counts as an update?
+Changelogger triggers when an extension is installed or updated. It then checks if the installed version is the latest version on addons.mozilla.org.
+ * If it is, it tries to fetch the changelog from AMO.
+ * If it isn't (or if it's a self distributed addon that's not available on AMO), it does not look for a changelog.
+This way, you can manually install older or development versions of extensions without triggering Changelogger.
+
+Changelogger looks for changelogs in your browser's locale, and falls back to the default locale for the extension.
+
+## "No Changelog found for this version"
+Updates will be logged by Changelogger even if there was no changelog included with the update. You can change this by enabling "Ignore Updates Without Changelogs" in the options.
 
-Adknowledgements:
+## Acknowledgements:
  * Icons from [Material Design Icons](https://materialdesignicons.com/) ([OFL 1.1](http://scripts.sil.org/OFL))
- * Uses Mozilla's [Addons Server API](https://addons-server.readthedocs.io/en/2018.05.17/topics/api/addons.html)
+ * Uses Mozilla's [Addons Server API](https://addons-server.readthedocs.io/en/latest/topics/api/v4_frozen/addons.html)