Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions .github/workflows/changesets.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ jobs:

- name: Create version pull request
id: changesets
uses: changesets/action@e0145edc7d9d8679003495b11f87bd8ef63c0cba # v1.5.3
uses: changesets/action@a45c4d594aa4e2c509dc14a9f2b3b67ba3780d0d # v1.9.0
with:
title: 'chore: version packages'
commit: 'chore: version packages'
Expand Down Expand Up @@ -76,7 +76,7 @@ jobs:
skip-cache: true # avoid cache poisoning attacks

- name: Publish to npm
uses: changesets/action@e0145edc7d9d8679003495b11f87bd8ef63c0cba # v1.5.3
uses: changesets/action@a45c4d594aa4e2c509dc14a9f2b3b67ba3780d0d # v1.9.0
with:
createGithubReleases: true
publish: pnpm changeset:publish
Expand Down
49 changes: 47 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,48 @@
# OpenIndex
<br/>

An npm package template.
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/0xSplits/openindex/blob/main/.github/openindex-dark.svg">
<img alt="OpenIndex logo" src="https://github.com/0xSplits/openindex/blob/main/.github/openindex-light.svg" width="auto" height="200">
</picture>
</p>

<p align="center">
<a href="https://www.npmjs.com/package/openindex">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/openindex?colorA=21262d&colorB=21262d&style=flat">
<img src="https://img.shields.io/npm/v/openindex?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Version">
</picture>
</a>
<a href="https://github.com/0xSplits/openindex/blob/main/LICENSE">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/l/openindex?colorA=21262d&colorB=21262d&style=flat">
<img src="https://img.shields.io/npm/l/openindex?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="MIT License">
</picture>
</a>
<a href="https://app.codecov.io/gh/0xSplits/openindex">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/codecov/c/github/0xSplits/openindex?colorA=21262d&colorB=21262d&style=flat">
<img src="https://img.shields.io/codecov/c/github/0xSplits/openindex?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Code coverage">
</picture>
</a>
</p>

## Overview

OpenIndex is a lightweight, type-safe EVM indexer built on [viem](https://viem.sh). It uses imperative event handlers so you have full control over event filters, transforms, and storage.

## Install

```bash
npm install openindex viem
```

## Documentation

[Head to the documentation](https://openindex.dev) to read and learn more about OpenIndex.

## Community

- Follow [@0xSplits](https://x.com/0xSplits) on X for project updates
- Join the [discussions on GitHub](https://github.com/0xSplits/openindex/discussions)
16 changes: 8 additions & 8 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/gregfromstl/openindex/blob/main/.github/openindex-dark.svg">
<img alt="OpenIndex logo" src="https://github.com/gregfromstl/openindex/blob/main/.github/openindex-light.svg" width="auto" height="200">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/0xSplits/openindex/blob/main/.github/openindex-dark.svg">
<img alt="OpenIndex logo" src="https://github.com/0xSplits/openindex/blob/main/.github/openindex-light.svg" width="auto" height="200">
</picture>
</p>

Expand All @@ -14,16 +14,16 @@
<img src="https://img.shields.io/npm/v/openindex?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Version">
</picture>
</a>
<a href="https://github.com/gregfromstl/openindex/blob/main/LICENSE">
<a href="https://github.com/0xSplits/openindex/blob/main/LICENSE">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/l/openindex?colorA=21262d&colorB=21262d&style=flat">
<img src="https://img.shields.io/npm/l/openindex?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="MIT License">
</picture>
</a>
<a href="https://app.codecov.io/gh/gregfromstl/openindex">
<a href="https://app.codecov.io/gh/0xSplits/openindex">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/codecov/c/github/gregfromstl/openindex?colorA=21262d&colorB=21262d&style=flat">
<img src="https://img.shields.io/codecov/c/github/gregfromstl/openindex?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Code coverage">
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/codecov/c/github/0xSplits/openindex?colorA=21262d&colorB=21262d&style=flat">
<img src="https://img.shields.io/codecov/c/github/0xSplits/openindex?colorA=f6f8fa&colorB=f6f8fa&style=flat" alt="Code coverage">
</picture>
</a>
</p>
Expand All @@ -38,5 +38,5 @@ OpenIndex is a TypeScript library. <!-- TODO: describe what OpenIndex actually d

## Community

- Follow [@gregfromstl](https://x.com/gregfromstl) on X for project updates
- Join the [discussions on GitHub](https://github.com/gregfromstl/openindex/discussions)
- Follow [@0xSplits](https://x.com/0xSplits) on X for project updates
- Join the [discussions on GitHub](https://github.com/0xSplits/openindex/discussions)
2 changes: 1 addition & 1 deletion src/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "openindex",
"description": "A typescript npm package template.",
"description": "Easier Indexing for Ethereum",
"version": "0.0.1",
"type": "module",
"main": "./_cjs/index.js",
Expand Down
Loading