@xkeshav/gh-repo-check - npm Package Compare versions

Comparing version 1.0.2 to 1.2.1

package.json

 {
   "name": "@xkeshav/gh-repo-check",
-  "version": "1.0.2",
+  "version": "1.2.1",
   "private": false,
@@ -30,11 +30,12 @@ "displayName": "github-repo-check",
     "health-check",
-    "repo=health-check",
+    "repo-health-check",
     "community files",
     "health files",
+    "community health files",
+    "open source",
     "gh-repo-check",
     "cli",
-    "github",
+    "GitHub",
     "issues templates",
-    "discussion templates",
-    "template"
+    "discussion templates"
   ],
@@ -55,7 +56,7 @@ "bin": {
     "prepublish": "npm run clean",
-    "publish": "npm publish --access=public"
+    "version": "npm publish --access=public"
   },
   "timestamp": {
     "createdOn": "29 Sep 2024",
-    "updatedOn": "29 Sep 2024"
+    "updatedOn": "30 Sep 2024"
   },
@@ -66,8 +67,6 @@ "dependencies": {
     "path": "0.12.7",
-    "replace-in-file": "8.2.0",
-    "semver": "^7.6.3"
+    "replace-in-file": "8.2.0"
   },
   "devDependencies": {
-    "prettier": "^3.3.3",
-    "typescript": "latest"
+    "prettier": "3.3.3"
   },
@@ -87,4 +86,4 @@ "browserslist": {
   "engines": {
-    "node": ">=20"
+    "node": ">=18"
   }
 }

README.md

@@ -14,15 +14,27 @@ # GitHub Health File Check
 
+```bash
+ npx gh-repo-check
+```
+
 ![gh-repo-check demo gif](src/assets/images/output.gif)
 
-## What it is ?
+## What are Community Health Files?
 
-> [!Tip]
-> Read [Official GitHub Docs][community-files] to know what are community health files
+> [!TIP]
+> Read official Github docs to know more about [Community Health Files][community-files].
 
-This is a npm based CLI tool which help to check your GitHub repo and generate community health files in `.github` folder (if not exist) or user defined folder name.
+## What this package does ?
 
-This tool update necessary details in the community health files and apart from that this tool help to generate customized issues and discussions template
+This is a npm based CLI tool check your GitHub repo and generate basic community health files in `.github` folder (if not exist) or user defined folder.
 
-and below are the files in generated folder
+This tool generate below files with your personalized information
 
+- necessary community health files
+- Issues templates
+- Discussions templates
+- Pull Request template
+- Funding information
+
+and below is the final folder structure
+
 <details><summary>
@@ -61,3 +73,3 @@ <mark> Health File Tree</mark>
 
-this is optional
+install the repo in your node based project
 
@@ -74,12 +86,7 @@ ```bash
 
-it will ask few question and then generate files,
+it will ask few questions and then generate files.
 
-> [!Note]
-> if you already have `.github` folder in your repo, then it will ask new folder name, where it will generate
-> later you have to move these files into `.github` folder, to make it useful.
+> [!NOTE]
+> if you have `.github` folder in your repo, then it will ask for a folder name, where it will generate the files, but later you have to move these files into `.github` folder, to make it useful.
 
-### Note
-
-one file _Funding.yml_ file get generated, you can keep it empty for now.
-
 ## License
@@ -86,0 +93,0 @@

New alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

668419

Dependency count

4

decreased by-20%

Dev dependency count

1

decreased by-50%

Number of lines in readme file

110

increased by6.8%

Worsened metrics

Number of medium maintenance alerts

1

increased byInfinity%

Dependency changes

• - Removedsemver@^7.6.3

• - Removedsemver@7.7.1(transitive)