Skip to content

Commit 0e1107f

Browse files
committed
update: add new features
1 parent 24c17c2 commit 0e1107f

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ This package simplifies data retrieval and analysis from GitHub, making it an ex
77
## Features
88

99
- Fetch user profiles and filter screen data.
10-
- Fetch and filter `commits`, `repositories`, and `languages` coverages.
11-
- Analyze commits per each year.
10+
- Fetch and filter `commits`, `repositories`, `contributions` and `languages` coverages.
11+
- Analyze commits and contributions per each year.
1212
- Analyze repos — tops, star counts, and details.
13-
- Analyze language coverage per each repo, top languages, and percentages.
13+
- Analyze language coverage including repo count, top languages, and percentages.
1414

1515
## Installation
1616

@@ -30,17 +30,19 @@ You can use the package by importing individual methods or use the default expor
3030

3131
### Option A — Named imports
3232
```ts
33-
import { getUserProfile, commitSummarizar, repoSummarizer, lngSummarizer } from "wrap-git";
33+
import { getGitHubUser, getGitHubCommits, getGitHubContributions, getGitHubContributionTypesPerYear, getGitHubLanguages, getGitHubRepos, getGitHubPinnedRepos } from "wrap-git";
3434

35-
const userProfile = await getUserProfile('sgc93'); // don't forget to handle errors
35+
36+
const userProfile = await getGitHubUser('sgc93', token); // don't forget to handle errors
3637
```
3738

3839
### Option B — Default import
3940
```ts
4041
import wrapGit from "wrap-git";
4142

42-
const { getUserProfile, commitSummarizar, repoSummarizer, lngSummarizer } = wrapGit;
43-
const userProfile = await getUserProfile('sgc93'); // don't forget to handle errors
43+
const { getGitHubUser, getGitHubCommits, getGitHubContributions, getGitHubContributionTypesPerYear, getGitHubLanguages, getGitHubRepos, getGitHubPinnedRepos } = wrapGit;
44+
45+
const userProfile = await getGitHubUser('sgc93', token); // don't forget to handle errors
4446
```
4547

4648
## Contributing

0 commit comments

Comments
 (0)