chore(repo): update readme

fdarian · Jun 24, 2024 · 38f4e9b · 38f4e9b
1 parent 52c7d9c
commit 38f4e9b
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@
 
 In this version, the focus is still on the query and mutation capabilities of the generated Drizzle schema.
 
+
 ## Features
 
 https://github.com/farreldarian/prisma-generator-drizzle/assets/62016900/35b57135-614e-4e07-920b-9e9a487eb6cb
@@ -19,6 +20,14 @@ _\*Only supports default scalar for now and more constraints will be added in fu
 
 > This project is still considered as experimental, but you can safely use it for production. Follow the progress on [v1](https://github.com/farreldarian/prisma-generator-drizzle/issues/1).
 
+
+### Get started
+- [Installation](#installation)
+- [Usages](#usages)
+- [Configuration](#configuration)
+- [Example](#example) 
+- [Gotchas](#gotchas)
+
 ## Installation
 
 ### 1. Install the package
@@ -106,6 +115,8 @@ export default defineConfig({
 
 ### Generate [`.$defaultFn()`](https://arc.net/l/quote/cmywscsv) Custom Default Initializer
 
+> ⚠️ DEPRECATED , will be replace by `drizzle.custom` directive
+
 Add `/// drizzle.default <module>::<named-function-import>` directive above the field definition to generate a custom default initializer.
 
 > NOTE: This will override any `@default(...)` attribute from the schema.
@@ -156,6 +167,9 @@ export const users = pgTable('User', {
 
 ### Generate [`.$type<..>()`](https://orm.drizzle.team/docs/column-types/mysql#customizing-column-data-type) Type Customization
 
+
+> ⚠️ DEPRECATED , will be replace by `drizzle.custom` directive
+
 Add `/// drizzle.type <module>::<named-import>` directive above the field definition.
 
 ```prisma
@@ -197,6 +211,11 @@ export const users = pgTable('User', {
   ...
 })
 ```
+
+## Example
+1. [with-drizzle-prisma](./examples/with-drizzle-prisma/): using drizzle's prisma extension
+
+
 ## Gotchas
 ### Relative import paths need explicit file extensions in ECMAScript imports when '--moduleResolution' is 'node16' or 'nodenext'.
 

diff --git a/packages/generator/README.md b/packages/generator/README.md
@@ -1,9 +1,12 @@
 # prisma-generator-drizzle
 
+[![Test](https://github.com/farreldarian/prisma-generator-drizzle/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/farreldarian/prisma-generator-drizzle/actions/workflows/test.yml)
+
 **prisma-generator-drizzle** is a [Prisma](https://www.prisma.io/) generator that lets you generate a [Drizzle](https://orm.drizzle.team/) schema. It is specifically designed for (existing) projects that are using Prisma and want to migrate to Drizzle, or for projects that want to use both Prisma and Drizzle together.
 
 In this version, the focus is still on the query and mutation capabilities of the generated Drizzle schema.
 
+
 ## Features
 
 https://github.com/farreldarian/prisma-generator-drizzle/assets/62016900/35b57135-614e-4e07-920b-9e9a487eb6cb
@@ -17,6 +20,14 @@ _\*Only supports default scalar for now and more constraints will be added in fu
 
 > This project is still considered as experimental, but you can safely use it for production. Follow the progress on [v1](https://github.com/farreldarian/prisma-generator-drizzle/issues/1).
 
+
+### Get started
+- [Installation](#installation)
+- [Usages](#usages)
+- [Configuration](#configuration)
+- [Example](#example) 
+- [Gotchas](#gotchas)
+
 ## Installation
 
 ### 1. Install the package
@@ -71,6 +82,7 @@ In addition to the Prisma features, you can also generate Drizzle-specific featu
 | relationalQuery | Flag to generate relational query | true        | false       |
 | moduleResolution         | Specify the [module resolution](https://www.typescriptlang.org/tsconfig#moduleResolution) that will affect the import style | _*auto_           | nodenext        |
 | verbose         | Flag to enable verbose logging    | -           | true        |
+| abortOnFailedFormatting | Flag to throw exception when formatting fails | true | false |
 | **dateMode | Change the generated mode for date | "date" ||
 
 _* It will find the closest tsconfig from the current working directory. Note that [extends](https://www.typescriptlang.org/tsconfig#extends) is not supported_
@@ -103,6 +115,8 @@ export default defineConfig({
 
 ### Generate [`.$defaultFn()`](https://arc.net/l/quote/cmywscsv) Custom Default Initializer
 
+> ⚠️ DEPRECATED , will be replace by `drizzle.custom` directive
+
 Add `/// drizzle.default <module>::<named-function-import>` directive above the field definition to generate a custom default initializer.
 
 > NOTE: This will override any `@default(...)` attribute from the schema.
@@ -153,6 +167,9 @@ export const users = pgTable('User', {
 
 ### Generate [`.$type<..>()`](https://orm.drizzle.team/docs/column-types/mysql#customizing-column-data-type) Type Customization
 
+
+> ⚠️ DEPRECATED , will be replace by `drizzle.custom` directive
+
 Add `/// drizzle.type <module>::<named-import>` directive above the field definition.
 
 ```prisma
@@ -194,6 +211,11 @@ export const users = pgTable('User', {
   ...
 })
 ```
+
+## Example
+1. [with-drizzle-prisma](../../examples/with-drizzle-prisma/): using drizzle's prisma extension
+
+
 ## Gotchas
 ### Relative import paths need explicit file extensions in ECMAScript imports when '--moduleResolution' is 'node16' or 'nodenext'.