Skip to content

Commit 7bc9b43

Browse files
committed
docs: add SECURITY.md and LICENSE.md, update README badges
- Added a SECURITY.md for reporting vulnerabilities and disclosure practices. - Added LICENSE.md with the MIT license details. - Updated README with new badges for CI and license links.
1 parent 73c8d6a commit 7bc9b43

3 files changed

Lines changed: 68 additions & 7 deletions

File tree

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) 2025 Addon Stack; Anjey Tsibylskij
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# @adnbn/plugin-reg-cs
22

3-
[![npm version](https://img.shields.io/npm/v/@adnbn/plugin-reg-cs.svg)](https://www.npmjs.com/package/@adnbn/plugin-reg-cs)
3+
[![npm version](https://img.shields.io/npm/v/@adnbn/plugin-reg-cs.svg?logo=npm)](https://www.npmjs.com/package/@adnbn/plugin-reg-cs)
44
[![npm downloads](https://img.shields.io/npm/dm/@adnbn/plugin-reg-cs.svg)](https://www.npmjs.com/package/@adnbn/plugin-reg-cs)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.md)
6+
[![CI](https://github.com/addon-stack/plugin-reg-cs/actions/workflows/ci.yml/badge.svg)](https://github.com/addon-stack/plugin-reg-cs/actions/workflows/ci.yml)
57

6-
A plugin for [Addon Bone](https://github.com/addonbone) that automatically registers and injects content scripts when your browser extension is installed.
8+
A plugin for [Addon Bone](https://addonbone.com) that automatically registers and injects content scripts when your browser extension is installed.
79

810
## Key Features
911

@@ -72,8 +74,3 @@ export default defineConfig({
7274
If your content scripts aren't being injected:
7375

7476
- Make sure you have included the necessary URL patterns in `host_permissions` in your manifest, otherwise the API won't have access to those tabs
75-
76-
77-
## License
78-
79-
MIT © Addon Bone

SECURITY.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
We aim to maintain the latest release line of this project. If you use an older version, please consider upgrading to receive security fixes.
6+
7+
## Reporting a Vulnerability
8+
9+
Please report security issues privately and avoid opening public issues with exploitable details.
10+
11+
- Preferred contact: addonbonedev@gmail.com
12+
- For non-sensitive/general bugs, use the issue tracker: https://github.com/addon-stack/plugin-reg-cs/issues
13+
14+
When reporting, please include (if possible):
15+
16+
- Affected version(s) and package name (adnbn) and how you installed it
17+
- Environment details (OS, Node.js version, browser/runtime, relevant configs)
18+
- Steps to reproduce and a minimal proof of concept (PoC)
19+
- Impact assessment (what an attacker can do and likely severity)
20+
21+
We will acknowledge your report within 72 hours and keep you informed as we triage and address the issue.
22+
23+
## Coordinated Disclosure
24+
25+
We follow coordinated disclosure practices:
26+
27+
- We collaborate with you to verify the issue and determine the fix.
28+
- A fix will be released as soon as feasible, depending on severity and complexity.
29+
- After a fix is available, we will publish release notes describing the impact and mitigation.
30+
- Please refrain from public disclosure until a fix has been released or we agree on a timeline together.
31+
32+
## Credit
33+
34+
We are happy to acknowledge reporters in release notes (unless you prefer to remain anonymous). If you would like a specific name or handle to be used, let us know.
35+
36+
## CVEs and Bounties
37+
38+
- CVE assignment may be considered on a case-by-case basis.
39+
- We do not operate a bug bounty program at this time.
40+
41+
## Scope
42+
43+
This policy covers the code and packages maintained in this repository. Issues in third-party dependencies should be reported upstream to their maintainers when appropriate.

0 commit comments

Comments
 (0)