Skip to content

Commit 5bb79c8

Browse files
committed
docs: update README and package for repo rename
1 parent 28fa8d2 commit 5bb79c8

3 files changed

Lines changed: 26 additions & 15 deletions

File tree

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# Github Top Languages
1+
# Github Top Languages API
22

3-
Generate a top languages chart for your GitHub profile that you can embed in a README or website.
3+
Deployable **GitHub language chart generator** — embeddable SVGs for READMEs and websites.
44

5-
[![Tests](https://github.com/masonlet/github-top-languages/actions/workflows/tests.yml/badge.svg)](https://github.com/masonlet/github-top-languages/actions/workflows/tests.yml)
6-
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE)
5+
[![Tests](https://github.com/masonlet/github-top-languages-api/actions/workflows/tests.yml/badge.svg)](https://github.com/masonlet/github-top-languages-api/actions/workflows/tests.yml)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-green)](./LICENSE)
7+
![Node](https://img.shields.io/badge/Node.js-20+-green)
78

89
![Example 8 Top Languages Chart](images/default8.png)
910

@@ -26,7 +27,12 @@ Generate a top languages chart for your GitHub profile that you can embed in a R
2627
## Table of Contents
2728
- [Features](#features)
2829
- [Usage](#usage)
30+
- [Parameters](#customization-options)
2931
- [Deployment & Configuration](#deployment--configuration)
32+
- [Prerequisites](#prerequisites)
33+
- [Configure `.env`](#configuration)
34+
- [Local Development](#running-locally)
35+
- [Deploying](#deployment)
3036
- [License](#license)
3137

3238
## Features
@@ -88,8 +94,8 @@ To get 10 languages, a dark theme, and a custom title:
8894

8995
### Installation
9096
```bash
91-
git clone https://github.com/masonlet/github-top-languages.git
92-
cd github-top-languages
97+
git clone https://github.com/masonlet/github-top-languages-api.git
98+
cd github-top-languages-api
9399
npm install
94100
```
95101

@@ -108,7 +114,7 @@ vercel dev
108114

109115
### Deployment
110116

111-
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/masonlet/github-top-languages&env=GITHUB_USERNAMES,GITHUB_TOKEN,IGNORED_REPOS&envDescription[GITHUB_USERNAMES]=Comma-separated%20GitHub%20usernames&envDescription[IGNORED_REPOS]=Optional%20comma-separated%20repos%20to%20exclude&envDescription[GITHUB_TOKEN]=Optional%20GitHub%20personal%20access%20token%20for%20higher%20rate%20limits)
117+
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/masonlet/github-top-languages-api&env=GITHUB_USERNAMES,GITHUB_TOKEN,IGNORED_REPOS&envDescription[GITHUB_USERNAMES]=Comma-separated%20GitHub%20usernames&envDescription[IGNORED_REPOS]=Optional%20comma-separated%20repos%20to%20exclude&envDescription[GITHUB_TOKEN]=Optional%20GitHub%20personal%20access%20token%20for%20higher%20rate%20limits)
112118

113119
> The default endpoint is /api/languages
114120

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,30 @@
11
{
2-
"name": "github-top-languages",
3-
"version": "0.0.1",
2+
"name": "github-top-languages-api",
43
"description": "Github Top Languages card generator",
54
"main": "index.js",
5+
"author": "Mason L'Etoile",
6+
"license": "MIT",
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/masonlet/github-top-languages-api"
10+
},
11+
"keywords": ["typescript", "github-profile", "github-readme", "top-languages", "svg"],
12+
"version": "1.0.0",
13+
"type": "module",
614
"scripts": {
715
"test": "vitest",
816
"test:watch": "vitest --watch",
917
"test:coverage": "vitest --coverage",
1018
"typecheck": "tsc --noEmit"
1119
},
12-
"author": "Mason L'Etoile",
13-
"license": "MIT",
14-
"type": "module",
20+
"dependencies": { "github-top-languages-lib": "^1.0.1" },
1521
"devDependencies": {
1622
"typescript": "^5.0.0",
1723
"@vercel/node": "^5.7.17",
1824
"@types/node": "^25.3.1",
1925
"vitest": "^4.0.17",
2026
"@vitest/coverage-v8": "^4.0.17"
2127
},
22-
"dependencies": { "github-top-languages-lib": "^1.0.1" },
2328
"overrides": {
2429
"minimatch": "10.2.5",
2530
"smol-toml": "1.6.1",

0 commit comments

Comments
 (0)