Skip to content

Commit 252bc17

Browse files
committed
docs: update package description and author url
1 parent 45180f7 commit 252bc17

File tree

2 files changed

+6
-5
lines changed

2 files changed

+6
-5
lines changed

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
"name": "read-git-user",
33
"version": "2.1.0",
44
"type": "module",
5-
"description": "Reads the Github username and email from .gitconfig and return it as a json object",
5+
"description": "Returns the GitHub username and email of the current system's .gitconfig",
66
"keywords": ["git", "config", "username", "email", "git username", "local"],
77
"repository": "RocktimSaikia/read-git-user",
88
"license": "MIT",
99
"author": {
1010
"name": "Rocktim Saikia",
1111
"email": "[email protected]",
12-
"url": "https://rocktim.xyz"
12+
"url": "https://rocktimsaikia.dev"
1313
},
1414
"files": ["index.d.ts", "index.js"],
1515
"scripts": {

readme.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
Returns the GitHub username and email of the current system's `.gitconfig`.
44

55
> [!NOTE]
6-
> This method retrieves the original GitHub username since the stored \
7-
> git config name is not reliable. The name can be changed without \
8-
> affecting the original GitHub username.
6+
> This function retrieves the original GitHub username since the stored \
7+
> git config name is not reliable. The local name can be changed without \
8+
> affecting any Git or GitHub activities as long as the email matches any \
9+
> verified emails on the GitHub account.
910
1011
[![Tests](https://github.com/rocktimsaikia/read-git-user/actions/workflows/main.yml/badge.svg)](https://github.com/rocktimsaikia/read-git-user/actions/workflows/main.yml) [![npm](https://img.shields.io/npm/v/read-git-user?color=bright)](https://npmjs.com/package/read-git-user)
1112

0 commit comments

Comments
 (0)