@dytsou/github-readme-stats 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/API.md +525 -0
- package/openapi.yaml +923 -0
- package/package.json +8 -6
- package/readme.md +13 -1
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dytsou/github-readme-stats",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "Dynamically generate stats for your GitHub readme",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"github-readme-stats",
|
|
@@ -19,20 +19,22 @@
|
|
|
19
19
|
"api",
|
|
20
20
|
"themes",
|
|
21
21
|
"LICENSE",
|
|
22
|
-
"readme.md"
|
|
22
|
+
"readme.md",
|
|
23
|
+
"openapi.yaml",
|
|
24
|
+
"API.md"
|
|
23
25
|
],
|
|
24
26
|
"publishConfig": {
|
|
25
27
|
"access": "public"
|
|
26
28
|
},
|
|
27
|
-
"homepage": "https://github.com/
|
|
29
|
+
"homepage": "https://github.com/dytsou/github-readme-stats",
|
|
28
30
|
"bugs": {
|
|
29
|
-
"url": "https://github.com/
|
|
31
|
+
"url": "https://github.com/dytsou/github-readme-stats/issues"
|
|
30
32
|
},
|
|
31
33
|
"repository": {
|
|
32
34
|
"type": "git",
|
|
33
|
-
"url": "https://github.com/
|
|
35
|
+
"url": "https://github.com/dytsou/github-readme-stats.git"
|
|
34
36
|
},
|
|
35
|
-
"author": "
|
|
37
|
+
"author": "dytsou",
|
|
36
38
|
"license": "MIT",
|
|
37
39
|
"devDependencies": {
|
|
38
40
|
"@actions/core": "^1.11.1",
|
package/readme.md
CHANGED
|
@@ -58,7 +58,7 @@ Display your GitHub statistics including stars, commits, pull requests, and more
|
|
|
58
58
|
|
|
59
59
|
| Parameter | Description | Example |
|
|
60
60
|
|-----------|-------------|---------|
|
|
61
|
-
| `username` | GitHub username (required) | `
|
|
61
|
+
| `username` | GitHub username (required) | `NAME` |
|
|
62
62
|
| `theme` | Theme name | `dark`, `radical`, `merko`, etc. |
|
|
63
63
|
| `hide` | Hide specific stats | `stars,commits,prs` |
|
|
64
64
|
| `show` | Show additional stats | `reviews,discussions_started` |
|
|
@@ -398,6 +398,18 @@ Use HTML with `align` attribute:
|
|
|
398
398
|
|
|
399
399
|
---
|
|
400
400
|
|
|
401
|
+
## API Documentation
|
|
402
|
+
|
|
403
|
+
For comprehensive API documentation including all endpoints, parameters, response formats, error handling, and examples, see [API.md](API.md) or [API Documentation](https://dytsou.github.io/github-readme-stats/).
|
|
404
|
+
|
|
405
|
+
**OpenAPI Specification:** The API is also available as an OpenAPI 3.1.0 specification in [openapi.yaml](openapi.yaml). You can use this with tools like:
|
|
406
|
+
- [Swagger UI](https://swagger.io/tools/swagger-ui/) for interactive API exploration
|
|
407
|
+
- [Postman](https://www.postman.com/) for API testing
|
|
408
|
+
- Code generators for client SDKs
|
|
409
|
+
- API documentation generators
|
|
410
|
+
|
|
411
|
+
---
|
|
412
|
+
|
|
401
413
|
## Support
|
|
402
414
|
|
|
403
415
|
Contributions are welcome! If you find this project useful:
|