Skip to content

Commit 75d1b38

Browse files
committed
Adds package metadata and improves documentation
Enhances package discoverability and maintainability by providing description, keywords, author info, repository details, and homepage links. Improves clarity for users and contributors.
1 parent 2c87a1a commit 75d1b38

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# gatsby-source-github-graphql-get-user
2+
3+
A Gatsby source plugin for sourcing GitHub User data using the GitHub GraphQL API. Must be used as a sub-plugin of `@libsrcdev/gatsby-source-github-graphql`.
4+
5+
This repository doesn't fetch recursively and the target users must be explicitly specified.
6+
7+
See the example app under `/examples` for usage details.
Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,30 @@
11
{
22
"name": "@libsrcdev/gatsby-source-github-graphql-get-user",
33
"version": "0.1.0",
4+
"description": "A Gatsby source plugin for sourcing GitHub User data using the GitHub GraphQL API. Must be used as a sub-plugin of `@libsrcdev/gatsby-source-github-graphql`.",
5+
"keywords": [
6+
"gatsby",
7+
"source",
8+
"github",
9+
"graphql",
10+
"get",
11+
"user",
12+
"data",
13+
"org"
14+
],
15+
"homepage": "https://github.com/libsrcdev/gatsby-source-github-graphql#readme",
16+
"bugs": {
17+
"url": "https://github.com/libsrcdev/gatsby-source-github-graphql/issues"
18+
},
19+
"repository": {
20+
"type": "git",
21+
"url": "git+https://github.com/libsrcdev/gatsby-source-github-graphql.git"
22+
},
23+
"license": "MIT",
24+
"author": "@libsrcdev",
25+
"type": "commonjs",
426
"main": "index.js",
5-
"license": "MIT"
27+
"scripts": {
28+
"test": "echo \"Error: no test specified\" && exit 1"
29+
}
630
}

0 commit comments

Comments
 (0)