From 7ecfbad82c38ba0112660d3ce57356400600908a Mon Sep 17 00:00:00 2001 From: gregfromstl Date: Tue, 30 Jun 2026 20:21:17 -0700 Subject: [PATCH 1/2] readmes --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++-- src/README.md | 16 ++++++++-------- src/package.json | 2 +- 3 files changed, 56 insertions(+), 11 deletions(-) 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.