Automated Discovery

Add Your Zig Project

No Pull Requests needed. Just tag your repository on GitHub, and our bot will automatically index it within the hour.

1
Prepare Your Repository
Ensure your project meets the basic requirements

Public Repository

Your repository must be public on GitHub.

Zig Project

Must contain Zig code or be related to the Zig ecosystem.

2
Add GitHub Topics
Add these topics to your repository's "About" section

Required Topic

Add one of these to categorize your project:

For Projects
zig-package
Or
zig-application

Optional Topic

You can optionally add this topic to show support:

zig-index
3
Wait for Indexing
Our bot scans GitHub every hour

What happens next?

The bot will fetch your repository details, README, releases, and dependency information (from build.zig.zon). It will then generate a JSON entry in the registry.

Updates automatically when you push changes
4
Write a Good README
Help users understand your project

A well-written README helps users understand what your project does and how to use it. Include these sections:

# Your Project Name

Short description of what your package does.

## Features

- Feature 1
- Feature 2
- Feature 3

## Installation

Add this to your `build.zig.zon`:

```zig
.dependencies = .{
    .your_package = .{
        .url = "https://github.com/you/your-package/archive/refs/tags/v1.0.0.tar.gz",
        .hash = "...",
    },
},
```

## Usage

```zig
const lib = @import("your_package");

pub fn main() !void {
    // Example usage
}
```

## API Reference

Document your public API here.

## License

MIT License - see LICENSE file for details.
What Happens Next?

Once your PR is merged, your project will appear on Zig Index immediately! The site is rebuilt automatically when changes are merged. Live stats (stars, forks, watchers) are fetched on-demand from GitHub.

Browse Projects

Frequently Asked Questions

Why use Zig Index?

The simplest way to discover quality Zig packages and applications. We provide an automated registry, live GitHub stats with smart caching, powerful search, and a community-driven contribution process.

How long until my project appears?

Our bot scans GitHub every hour. Once you add the required topic, your project should appear in the next indexing cycle.

Can I update my project information?

Yes! Just update your GitHub repository (description, topics, README). The bot will automatically detect changes and update the registry.

Can I remove my project from Zig Index?

Yes! Simply remove the zig-package or zig-application topic from your GitHub repository. The bot will remove it from the registry in the next cycle.

Where does the star/fork data come from?

Live stats are fetched from GitHub's API when users view the registry. This data is cached locally for performance. Your project's basic info (name, description) is synced from your GitHub repository.