github-contributions-ui 1.0.14 → 1.0.16

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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/package.json +22 -6
  3. package/readme.md +105 -5
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Bichitra Behera
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "github-contributions-ui",
3
- "version": "1.0.14",
3
+ "version": "1.0.16",
4
4
  "description": "GitHub contributions graph React component",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -28,11 +28,28 @@
28
28
  },
29
29
  "keywords": [
30
30
  "github",
31
- "react",
32
- "contributions",
33
- "graph",
34
- "ui"
31
+ "github contributions",
32
+ "react component",
33
+ "github graph",
34
+ "heatmap",
35
+ "portfolio",
36
+ "nextjs",
37
+ "opensource"
35
38
  ],
39
+ "repository": {
40
+ "type": "git",
41
+ "url": "https://github.com/bichitrabehera/github-contributions-ui.git"
42
+ },
43
+ "homepage": "https://github.com/bichitrabehera/github-contributions-ui#readme",
44
+ "bugs": {
45
+ "url": "https://github.com/bichitrabehera/github-contributions-ui/issues"
46
+ },
47
+ "publishConfig": {
48
+ "access": "public"
49
+ },
50
+ "engines": {
51
+ "node": ">=18"
52
+ },
36
53
  "license": "MIT",
37
54
  "peerDependencies": {
38
55
  "react": ">=18"
@@ -43,7 +60,6 @@
43
60
  "@types/react": "^18.0.0",
44
61
  "autoprefixer": "^10.4.27",
45
62
  "postcss": "^8.5.6",
46
- "react": ">=18",
47
63
  "tailwindcss": "^4.2.1",
48
64
  "tsup": "^8.5.1",
49
65
  "typescript": "^5.9.3"
package/readme.md CHANGED
@@ -1,15 +1,115 @@
1
1
  # github-contributions-ui
2
2
 
3
- GitHub contributions graph React component.
3
+ Display a **GitHub-style contributions graph** anywhere in your React or Next.js application.
4
4
 
5
- ## Install
5
+ A lightweight, plug-and-play component designed for developer portfolios, dashboards, and personal websites.
6
6
 
7
+ ---
8
+
9
+ ## ✨ Features
10
+
11
+ * GitHub-style contribution heatmap
12
+ * Plug-and-play setup
13
+ * Works with **React** and **Next.js**
14
+ * No API keys required
15
+ * Lightweight and fast
16
+ * Theme support
17
+ * Fully client-side
18
+
19
+ ---
20
+
21
+ ## 📦 Installation
22
+
23
+ ```bash
7
24
  npm install github-contributions-ui
25
+ ```
8
26
 
9
- ## Usage
27
+ ---
10
28
 
29
+ ## 🚀 Quick Start
30
+
31
+ ### Next.js (App Router)
32
+
33
+ ```tsx
11
34
  "use client";
35
+
12
36
  import { GithubActivity } from "github-contributions-ui";
13
- import "github-contributions-ui/styles.css";
14
37
 
15
- <GithubActivity username="octocat" />
38
+ export default function Page() {
39
+ return <GithubActivity username="octocat" theme="blue" />;
40
+ }
41
+ ```
42
+
43
+ ---
44
+
45
+ ### React (Vite / CRA)
46
+
47
+ ```tsx
48
+ import { GithubActivity } from "github-contributions-ui";
49
+
50
+ function App() {
51
+ return <GithubActivity username="octocat" theme="blue" />;
52
+ }
53
+
54
+ export default App;
55
+ ```
56
+
57
+ ---
58
+
59
+ ## ⚙️ Props
60
+
61
+ | Prop | Type | Required | Description |
62
+ | ---------- | ----------------------------------------- | -------- | --------------------------- |
63
+ | `username` | string | ✅ | GitHub username |
64
+ | `theme` | `"light" \| "dark" \| "blue" \| "purple"` | ❌ | UI theme (default: `light`) |
65
+
66
+ ### Example
67
+
68
+ ```tsx
69
+ <GithubActivity
70
+ username="octocat"
71
+ theme="dark"
72
+ />
73
+ ```
74
+
75
+ ---
76
+
77
+ ## 🎨 Available Themes
78
+
79
+ * `light`
80
+ * `dark`
81
+ * `blue`
82
+ * `purple`
83
+
84
+ ---
85
+
86
+ ## 🌐 Live Demo
87
+
88
+ Try it instantly:
89
+
90
+ 👉 https://github-contributions-ui.vercel.app/
91
+
92
+ ---
93
+
94
+ ## 💡 Use Cases
95
+
96
+ * Developer portfolios
97
+ * Personal websites
98
+ * SaaS dashboards
99
+ * Resume websites
100
+ * Developer profiles
101
+
102
+ ---
103
+
104
+ ## 🧱 Built With
105
+
106
+ * React
107
+ * TypeScript
108
+ * Next.js
109
+ * Tailwind CSS
110
+
111
+ ## ☕ Support
112
+
113
+ <a href="https://buymeacoffee.com/bichitrabehera" target="_blank">
114
+ <img src="https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20coffee&emoji=☕&slug=your-username&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff" />
115
+ </a>