Update README

L-Mario564 · Nov 25, 2023 · 5d25537 · 5d25537
1 parent 30d5a9b
commit 5d25537
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -191,21 +191,23 @@ ref likes_liked_by_id_users_id_fk: likes.liked_by_id > users.id [delete: no acti
 | Option     | Type     | Description                                                                                                                                                                                               |
 | ---------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | schema     | PgSchema | An object containing Postgres dialect tables, enums and relations                                                                                                                                         |
-| out        | string   | The output directory and file name. Uses the current working directory as the root                                                                                                                        |
+| out?       | string   | The output directory and file name. Uses the current working directory as the root. If not set, it will not write the DBML file.                                                                          |
 | relational | boolean? | If set to true, it will create references based on the relations generated with the `relations` function instead of foreign keys. Useful for databases that don't support foreign keys. Default: `false`. |
 
 **mysqlGenerate**
 
 | Option     | Type        | Description                                                                                                                                                                                               |
 | ---------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | schema     | MySqlSchema | An object containing MySQL dialect tables and relations                                                                                                                                                   |
-| out        | string      | The output directory and file name. Uses the current working directory as the root                                                                                                                        |
+| out?       | string      | The output directory and file name. Uses the current working directory as the root. If not set, it will not write the DBML file.                                                                          |
 | relational | boolean?    | If set to true, it will create references based on the relations generated with the `relations` function instead of foreign keys. Useful for databases that don't support foreign keys. Default: `false`. |
 
 **sqliteGenerate**
 
 | Option     | Type         | Description                                                                                                                                                                                               |
 | ---------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | schema     | SQLiteSchema | An object containing SQLite dialect tables and relations                                                                                                                                                  |
-| out        | string       | The output directory and file name. Uses the current working directory as the root                                                                                                                        |
+| out?       | string       | The output directory and file name. Uses the current working directory as the root. If not set, it will not write the DBML file.                                                                          |
 | relational | boolean?     | If set to true, it will create references based on the relations generated with the `relations` function instead of foreign keys. Useful for databases that don't support foreign keys. Default: `false`. |
+
+All generate functions return the DBML as a string regardless if a file is written or not, in case you want to do something with the generated DBML.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "drizzle-dbml-generator",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Convert your Drizzle ORM schema into DBML markup",
   "main": "dist/index.cjs",
   "module": "dist/index.js",