Skip to content

Commit

Permalink
Update readme, changelog, version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
Rayquaza01 committed May 21, 2024
1 parent 5503902 commit 1467a5c
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 15 deletions.
20 changes: 12 additions & 8 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Building History Cleaner 1.5.1
# Building History Cleaner 1.6.0

## System Info
* Fedora 39
* node v20.10.0
* npm 10.4.0
* Fedora 40
* node v20.12.2
* npm 10.5.0
* bash 5.2.26
* For tool and library versions, check package.json

# Building
# Building Manifest v2 (Firefox)

To build the extension, run:

Expand All @@ -17,20 +17,24 @@ npm install

# Build the extension
# Moves / bundles assets to dist
npm run build:prod
npm run build:ff:prod

# Zip extension for distribution
npm run build:extension
```

The built files will be in `./dist` and the complete extension will be `./web-ext-artifacts/history_cleaner-1.5.0.zip`
The built files will be in `./dist` and the complete extension will be `./web-ext-artifacts/history_cleaner-1.6.0.zip`

# Testing the extension

To test the extension, run:

```shell
npm run build:dev
# build manifest v2 version
npm run build:ff:dev

# build manifest v3 version
npm run build:cr:dev
```

This will build the extension to `./dist` and rebuild it on file changes. `./dist` can be loaded as a temporary extension in Chrome or Firefox.
13 changes: 11 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
v1.5.1 Changelog
v1.6.0 Changelog

Fix bug where notification would always display when deleting all history (<a href="https://github.com/Rayquaza01/HistoryCleaner/issues/34">#34</a>)
[Firefox]

Maintenance update, keep parity with Chrome

[Chrome]

Migrate to Manifest v3
Fix bug where notification would always display when deleting all history (<a href="https://github.com/Rayquaza01/HistoryCleaner/issues/34">#34</a>) (was fixed in 1.5.1 on Firefox)
Changed default trigger mode to timer
Remove idle support (See <a href="https://github.com/Rayquaza01/HistoryCleaner/issues/30">#30</a>)
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@ Firefox addon that deletes history older than a specified amount of days.
* Defaults to 0.
* Trigger Mode
* Whether the extension triggers on idle, on browser startup, or at a set interval.
* Defaults to idle.
* Idle Length
* Defaults to idle (Firefox)
* Defaults to timer (Chrome)
* Idle Length (Firefox Only)
* Amount of time in seconds the browser should idle before triggering.
* Only has effect if trigger mode is set to idle.
* Defaults to 60, minimum 15.
Expand All @@ -44,8 +45,10 @@ Firefox addon that deletes history older than a specified amount of days.

Clone this repository, and run `npm install` to install necessary dependencies and build tools.

* `npm run build:dev` will build the extension in watch mode for development.
* `npm run build:prod` will build the extension for production.
* `npm run build:ff:watch` will build the extension in watch mode for development.
* `npm run build:ff:prod` will build the extension for production.
* `build:cr:watch` and `build:cr:prod` will build the manifest v3 version of the extension for Chrome.
* The manifest v3 (Chrome) source is located under `./cr-src/`, whereas the manifest v2 (Firefox) source is under `./src/`
* `npm run firefox` will load `./dist/` as a temporary extension in Firefox.

## Acknowledgements
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "history-cleaner",
"version": "1.5.1",
"version": "1.6.0",
"description": "Firefox addon that deletes history older than a specified amount of days.",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit 1467a5c

Please sign in to comment.