diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..fccbcac --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +buy_me_a_coffee: VoidClancy diff --git a/.github/workflows/sync-docs.yml b/.github/workflows/sync-docs.yml index bb55f6b..c0eae3e 100644 --- a/.github/workflows/sync-docs.yml +++ b/.github/workflows/sync-docs.yml @@ -1,4 +1,4 @@ -name: Sync Documentation to Phi Website +name: Sync Docs on: push: diff --git a/.gitignore b/.gitignore index 771f67e..f2e0bd8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,4 @@ .env -*.md -!docs/*.md bin *.db .vscode diff --git a/README.md b/README.md new file mode 100644 index 0000000..42f7ea7 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Phi + +Phi is a **compile-time ORM for Go** that mirrors the Prisma developer experience. It parses your `schema.prisma` file and generates a type-safe client with zero reflection at runtime. + +## Features + +- **Compile-time type safety** - queries, predicates, and results are generated from your schema, so mistakes fail at build time, not runtime. +- **Zero runtime overhead** - no reflection, no sidecars. Everything compiles down to standard `database/sql`. +- **Prisma-style schema** - keep writing `schema.prisma` and get types, builders, and migrations generated from it. +- **Multi-provider** - PostgreSQL, SQLite (for now). +- **Schema migrations** - generate and apply migrations straight from the CLI, with optional embedded migrations. + +## Documentation + +[https://phi-orm.vercel.app](https://phi-orm.vercel.app) \ No newline at end of file diff --git a/mindmap.txt b/mindmap.txt deleted file mode 100644 index 6af38d4..0000000 --- a/mindmap.txt +++ /dev/null @@ -1,4 +0,0 @@ -Lexer produces tokens -Tokens are passed to parser which produces an AST -AST is passed to resolver which produces a schema (or the IR) -IR will be passed to do codegen and construct migrations \ No newline at end of file