Skip to content

Commit 9c08143

Browse files
committed
docs: make package description clearer
Signed-off-by: Jens Oliver Meiert <jens@meiert.com>
1 parent 3a73eb2 commit 9c08143

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
[![npm version](https://img.shields.io/npm/v/obsohtml.svg)](https://www.npmjs.com/package/obsohtml) [![Build status](https://github.com/j9t/obsohtml/workflows/Tests/badge.svg)](https://github.com/j9t/obsohtml/actions) [![Socket](https://badge.socket.dev/npm/package/obsohtml)](https://socket.dev/npm/package/obsohtml)
44

5-
ObsoHTML is a Node.js script designed to scan HTML, PHP, Nunjucks, Twig, JavaScript, and TypeScript files for obsolete or proprietary HTML attributes and elements. It helps you identify and update deprecated HTML code to be more sure to use web standards.
5+
ObsoHTML is a Node.js script designed to scan HTML, PHP, Nunjucks, Twig, JavaScript, and TypeScript files for obsolete and proprietary HTML elements and attributes. It helps you identify and update deprecated HTML code to be sure to use web standards.
66

7-
ObsoHTML has inherent limitations and may not find all obsolete attributes and elements. If you run into a problem, please [file an issue](https://github.com/j9t/obsohtml/issues).
7+
ObsoHTML has inherent limitations and may not find all obsolete elements and attributes. If you run into a problem, please [file an issue](https://github.com/j9t/obsohtml/issues).
88

99
## Usage
1010

@@ -78,7 +78,7 @@ node bin/obsohtml.js -f ../path/to/folder
7878

7979
## Output
8080

81-
The script will output messages to the console indicating any obsolete attributes or elements found in the scanned files, along with the file paths where they were detected.
81+
The script will output messages to the console indicating any obsolete elements or attributes found in the scanned files, along with the file paths where they were detected.
8282

8383
The script exits with code `1` if any obsolete HTML is found, and `0` if none is found, making it suitable for use in CI pipelines.
8484

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"dependencies": {
77
"commander": "^14.0.0"
88
},
9-
"description": "Obsolete and proprietary HTML finder",
9+
"description": "HTML checker for obsolete and proprietary elements and attributes",
1010
"funding": "https://github.com/j9t/obsohtml?sponsor=1",
1111
"homepage": "https://github.com/j9t/obsohtml",
1212
"keywords": [
@@ -33,5 +33,5 @@
3333
"test": "node --test bin/obsohtml.test.js"
3434
},
3535
"type": "module",
36-
"version": "1.9.8"
36+
"version": "1.9.9"
3737
}

0 commit comments

Comments
 (0)