@tokioapp/adblock 0.0.0 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -2
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,13 +1,17 @@
1
1
  # Tokio Adblock
2
2
 
3
- A content blocker for Electron that applies [uBlock Origin](https://github.com/gorhill/uBlock)'s filter lists inside an Electron session: network filters, cosmetic and procedural cosmetic filters, scriptlet injection and redirect resources. It is written from scratch, MIT-licensed, and has no runtime dependency. It is the blocker behind [Tokio](https://tokio.ialfaro.com)'s music player.
3
+ A content blocker for Electron that applies [uBlock Origin](https://github.com/gorhill/uBlock)'s filter lists inside an Electron session: network filters, cosmetic and procedural cosmetic filters, scriptlet injection and redirect resources. It is written from scratch, MIT-licensed, and has no runtime dependency. It is made for [Tokio](https://tokio.ialfaro.com)'s music player.
4
4
 
5
5
  ## Status
6
6
 
7
- In development. It isn't on npm yet, and the API can still change.
7
+ In development: the API can still change.
8
8
 
9
9
  ## Use
10
10
 
11
+ ```sh
12
+ yarn add @tokioapp/adblock
13
+ ```
14
+
11
15
  Electron 35 or later, Node 24 or later. The package is ESM only and ships its TypeScript types.
12
16
 
13
17
  ```ts
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tokioapp/adblock",
3
- "version": "0.0.0",
3
+ "version": "0.1.0",
4
4
  "description": "A clean-room, MIT content blocker for Electron that applies uBlock Origin's filter lists: network, cosmetic, procedural and scriptlet rules, with redirect resources.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",