chore(deps): bump actions/checkout from 6.0.1 to 7.0.0

.github/workflows/changesets.yml

@@ -32,7 +32,7 @@ jobs:
 
     steps:
       - name: Clone repository
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
           fetch-depth: 0
@@ -66,7 +66,7 @@ jobs:
 
     steps:
       - name: Clone repository
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           submodules: 'recursive'
 
@@ -96,7 +96,7 @@ jobs:
 
     steps:
       - name: Clone repository
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           submodules: 'recursive'
 

.github/workflows/prerelease.yml

@@ -7,7 +7,7 @@ jobs:
 
     steps:
       - name: Clone repository
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with:
           submodules: 'recursive'
 

.github/workflows/prune-tags.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Clone repository
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with: 
           submodules: 'recursive'
 

.github/workflows/verify.yml

@@ -11,7 +11,7 @@ jobs:
 
     steps:
       - name: Clone repository
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with: 
           submodules: 'recursive'
 
@@ -33,7 +33,7 @@ jobs:
 
     steps:
       - name: Clone repository
-        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
+        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
         with: 
           submodules: 'recursive'
 

README.md

@@ -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)

src/README.md

@@ -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>
 
@@ -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>
@@ -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)

src/package.json

@@ -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",