diff --git a/.github/workflows/changesets.yml b/.github/workflows/changesets.yml index bccfc35..e07ba1a 100644 --- a/.github/workflows/changesets.yml +++ b/.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' diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml index 3747fe9..662dee0 100644 --- a/.github/workflows/prerelease.yml +++ b/.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' diff --git a/.github/workflows/prune-tags.yml b/.github/workflows/prune-tags.yml index 3170cb7..155348f 100644 --- a/.github/workflows/prune-tags.yml +++ b/.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' diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml index 825b620..49faf06 100644 --- a/.github/workflows/verify.yml +++ b/.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' diff --git a/README.md b/README.md index 833c522..d3690df 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ -# OpenIndex +
-An npm package template. +

+ + + OpenIndex logo + +

+ +

+ + + + Version + + + + + + MIT License + + + + + + Code coverage + + +

+ +## 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) diff --git a/src/README.md b/src/README.md index 75a22c2..8b0c2c0 100644 --- a/src/README.md +++ b/src/README.md @@ -2,8 +2,8 @@

- - OpenIndex logo + + OpenIndex logo

@@ -14,16 +14,16 @@ Version - + MIT License - + - - Code coverage + + Code coverage

@@ -38,5 +38,5 @@ OpenIndex is a TypeScript library.