Skip to content

Commit d910404

Browse files
committed
chore: update package name to github-contrib-graph and clean up README
- Renamed npm package to github-contrib-graph - Updated CHANGELOG to reflect 3.0.0 as initial release - Cleaned up README badges and centered links - Updated all import examples to use new package name 🤖 Generated with [Claude Code](https://claude.ai/claude-code)
1 parent fd81a12 commit d910404

File tree

3 files changed

+21
-13
lines changed

3 files changed

+21
-13
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
A lightweight, customizable widget to embed your GitHub contribution graph on any website.
44

5-
[![npm version](https://img.shields.io/npm/v/github-contribution-graph.svg)](https://npmjs.com/package/github-contribution-graph)
6-
[![Live Demo](https://img.shields.io/badge/demo-live-brightgreen)](https://github-contribution-graph.netlify.app)
7-
[![Netlify Status](https://api.netlify.com/api/v1/badges/478cfe35-5d4d-4ec2-939b-b58e4de45ebe/deploy-status)](https://app.netlify.com/sites/github-contribution-graph/deploys)
5+
[![npm version](https://img.shields.io/npm/v/github-contrib-graph.svg)](https://npmjs.com/package/github-contrib-graph)
86
[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)
97

108
![Preview](assets/media/thumbnail.png)
119

12-
**[Live Demo](https://github-contribution-graph.netlify.app)** | **[GitHub Repo](https://github.com/iamjr15/github-contribution-graph)** | **[npm Package](https://npmjs.com/package/github-contribution-graph)**
10+
<p align="center">
11+
<a href="https://github-contribution-graph.netlify.app"><strong>Live Demo</strong></a> ·
12+
<a href="https://github.com/iamjr15/github-contribution-graph"><strong>GitHub Repo</strong></a> ·
13+
<a href="https://npmjs.com/package/github-contrib-graph"><strong>npm Package</strong></a>
14+
</p>
1315

1416
---
1517

@@ -18,14 +20,14 @@ A lightweight, customizable widget to embed your GitHub contribution graph on an
1820
Install via npm for React or vanilla JavaScript projects:
1921

2022
```bash
21-
npm install github-contribution-graph
23+
npm install github-contrib-graph
2224
```
2325

2426
### React
2527

2628
```tsx
27-
import { GitHubContributionGraph } from 'github-contribution-graph/react';
28-
import 'github-contribution-graph/styles.css';
29+
import { GitHubContributionGraph } from 'github-contrib-graph/react';
30+
import 'github-contrib-graph/styles.css';
2931

3032
function App() {
3133
return <GitHubContributionGraph username="octocat" theme="midnight" />;
@@ -35,8 +37,8 @@ function App() {
3537
### Vanilla JavaScript
3638

3739
```js
38-
import { GitHubContributionWidget } from 'github-contribution-graph/vanilla';
39-
import 'github-contribution-graph/styles.css';
40+
import { GitHubContributionWidget } from 'github-contrib-graph/vanilla';
41+
import 'github-contrib-graph/styles.css';
4042

4143
const widget = new GitHubContributionWidget({
4244
username: 'octocat',

packages/github-contribution-graph/CHANGELOG.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
## [1.0.0] - 2024-12-09
5+
## [3.0.1] - 2024-12-09
6+
7+
### Fixed
8+
9+
- Updated changelog documentation
10+
11+
## [3.0.0] - 2024-12-09
612

713
### Added
814

packages/github-contribution-graph/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"name": "github-contribution-graph",
3-
"version": "1.0.0",
2+
"name": "github-contrib-graph",
3+
"version": "3.0.1",
44
"description": "Lightweight, customizable GitHub contribution graph widget for any website",
55
"keywords": [
66
"github",
@@ -15,7 +15,7 @@
1515
"license": "Apache-2.0",
1616
"repository": {
1717
"type": "git",
18-
"url": "https://github.com/iamjr15/github-contribution-graph.git",
18+
"url": "git+https://github.com/iamjr15/github-contribution-graph.git",
1919
"directory": "packages/github-contribution-graph"
2020
},
2121
"homepage": "https://github-contribution-graph.netlify.app",

0 commit comments

Comments
 (0)