Skip to content

doc: update profile #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 20, 2025
Merged

doc: update profile #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 37 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# hackerrank-readme-stats
# Hackerrank Readme Stats
A beautiful way to display your [Hackerrank] profile badges in your Github readme or website.

> [!NOTE]
> Access your Hackerrank profile following the example in URL: `https://www.hackerrank.com/profile/samba9274`.

#### Example in Markdown:
```markdown
![Hackerrank Stats](https://hackerrank-stats.vercel.app/api?username={hackerrank-username})
```
#### Example in HTML:
```html
<p align="center">
<a href="https://github.com/samba9274/hackerrank-readme-stats">
<img src="https://hackerrank-stats.vercel.app/api?username={hackerrank-username}" alt="Hackerrank Stats"/>
</a>
</p>
```

## Parameters

| Name | Type | Description | Observations |
|-------------- |-------- |-------------------------- |--------------------- |
| Query Params | | | |
| username | string | Your Hackerrank username | Example `samba9274` |

## Usage

Expand All @@ -7,9 +31,20 @@ Copy the code below to your README.md and replace query parameter to your hacker
```md
![Hackerrank Stats](https://hackerrank-stats.vercel.app/api?username=samba9274)
```
![Hackerrank Stats](https://hackerrank-stats.vercel.app/api?username=samba9274)

With hyperlink:
#### With hyperlink:

```md
[![Hackerrank Stats](https://hackerrank-stats.vercel.app/api?username=samba9274)](https://www.hackerrank.com/samba9274)
```
[![Hackerrank Stats](https://hackerrank-stats.vercel.app/api?username=samba9274)](https://www.hackerrank.com/samba9274)

[Hackerrank]:https://www.hackerrank.com/

#### Display the badges centrilized in HTML:
<p align="center">
<a href="https://github.com/samba9274/hackerrank-readme-stats">
<img src="https://hackerrank-stats.vercel.app/api?username=samba9274" alt="Hackerrank Stats"/>
</a>
</p>