> ## Documentation Index
> Fetch the complete documentation index at: https://icons.mzrdev.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Start enhancing your GitHub profile in under 2 minutes.

## Using MZR Icons

MZR Icons is designed to be as simple as possible. You don't need to install any packages or manage API keys for basic usage. Just use our URL endpoints directly in your Markdown files.

### 1. Choose a Component

Pick the component you want to display (e.g., Trophies, Streaks, or Logo Icons).

### 2. Construct your URL

Use our base URL `https://icon.mzrdev.com/` followed by the endpoint and your GitHub username.

```markdown theme={null}
<!-- Example for GitHub Trophies -->
![](https://icon.mzrdev.com/trophy?username=MZRCode)
```

### 3. Add to your Profile

Copy and paste the Markdown code into your GitHub Profile README.

***

## Example: Trophy Cabinet

To display your trophies, use the `/api/trophy` endpoint:

```markdown theme={null}
[![Trophies](https://icon.mzrdev.com/trophy?username=MZRCode)](https://github.com/MZRCode/mzr-icons)
```

## Next Steps

Explore the core components to learn about advanced customization options like themes, layouts, and filters.

<CardGroup cols={3}>
  <Card title="Trophies" icon="trophy" href="/docs/components/trophies" />

  <Card title="Streaks" icon="fire" href="/docs/components/streaks" />

  <Card title="Logo Icons" icon="code" href="/docs/components/logo-icons" />
</CardGroup>
