Skip to content

Commit

Permalink
chore: update README and add an icon (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
mxgic1337 authored Jan 8, 2025
1 parent a1575a5 commit bac8d78
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 5 deletions.
Binary file added .github/assets/protonfox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Protonfox
Protonfox is an extension for [Firefox](https://firefox.com) that displays [ProtonDB](https://protondb.com) ratings on Steam.
<p align="center"><img alt="Icon" src=".github/assets/protonfox.png" /></p>
<h1 align="center">Protonfox</h1>
<p align="center">Protonfox is an extension for <a href="https://firefox.com">Firefox</a> that displays <a href="https://protondb.com">ProtonDB</a> ratings on Steam.</p>

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/mxgic1337/protonfox/build-check.yml?style=flat-square) ![GitHub package.json version](https://img.shields.io/github/package-json/v/mxgic1337/protonfox?style=flat-square)
<p align="center"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/mxgic1337/protonfox/build-check.yml?style=flat-square"> <img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/mxgic1337/protonfox?style=flat-square&logo=nodedotjs&logoColor=%23fff"> <img alt="Mozilla Add-on Version" src="https://img.shields.io/amo/v/protonfox-for-steam?style=flat-square&logo=firefox&logoColor=%23fff"></p>

<h3 align="center"><a href="https://addons.mozilla.org/en-US/firefox/addon/protonfox-for-steam/">🧩 Install for Firefox</a></p>

---

![preview.png](.github/assets/preview.png)

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "protonfox",
"version": "0.3.0",
"description": "Displays information about game compatibility with Proton on Steam.",
"version": "0.3.1",
"description": "Extension that displays information about game compatibility with Proton on Steam.",
"type": "module",
"scripts": {
"build": "webpack --mode production && node scripts/manifest.cjs"
Expand Down
4 changes: 4 additions & 0 deletions scripts/manifest.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@ const path = require('path')

const packageJsonContent = JSON.parse(fs.readFileSync(path.join(__dirname, '..', 'package.json')).toString())

const iconPath = path.join(__dirname, '..', 'src', 'assets', 'icon-48.png')
const iconDistPath = path.join(__dirname, '..', 'dist', 'assets', 'icon-48.png')
const manifestPath = path.join(__dirname, '..', 'src', 'manifest.json')
const manifestDistPath = path.join(__dirname, '..', 'dist', 'manifest.json')

fs.cpSync(iconPath, iconDistPath)

let manifestContent = fs.readFileSync(manifestPath).toString();
manifestContent = manifestContent.replaceAll('{{ version }}', packageJsonContent.version);
manifestContent = manifestContent.replaceAll('{{ description }}', packageJsonContent.description);
Expand Down
Binary file added src/assets/icon-48.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions src/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@
]
}
],
"icons": {
"48": "assets/icon-48.png"
},
"permissions": [
"*://*.protondb.com/api/v1/*"
]
Expand Down

0 comments on commit bac8d78

Please sign in to comment.