Skip to content

docs: improve README #287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
okwn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #287

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -293,4 +293,23 @@ PageIndex Blog, Sep 2025.

---

## License

MIT — see [LICENSE](LICENSE).

## Contributing

Contributions are welcome. Please ensure `bun run typecheck` and `bun run build` pass before submitting a PR.

## Testing

```sh
bun run typecheck
bun run build
```

There are no end-to-end tests yet. Until tests are added, typecheck + build are the verification surface.

---

© 2026 [Vectify AI](https://vectify.ai)