From bf2bd185056ee9b231942970856ddcea8b8563b3 Mon Sep 17 00:00:00 2001
From: platyscript <244315239+platyscript@users.noreply.github.com>
Date: Tue, 13 Jan 2026 14:18:25 +0530
Subject: [PATCH] update readme

---
 README.md                                     | 74 ++++++++++++++++++-
 .../DbApiBuilderEntityGenerator.csproj        |  2 +-
 2 files changed, 73 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 87af46a..a0c1072 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,72 @@
-# Platy.AdventureWorks.Entities
-Entities related to the AdventureWorks2022 database.
+# Data API Builder Entity generator
+
+This is a dotnet tool generates the [data-api-builder](https://learn.microsoft.com/en-us/azure/data-api-builder/) data-api-builder configuration file with the entites from an existing database.
+
+** This is currently alpha release **
+
+## Installation
+`dotnet tool install --global DbApiBuilderEntityGenerator --version 1.0.3-alpha`
+## Usage
+
+### Command
+
+`dab-entity-gen -p SqlServer -c Data Source=localhost;Initial Catalog=pubs;User ID=sa;Password=Passw0rd1;Encrypt=False`
+
+### Configuration file
+
+Sample Configuration file:
+
+```yaml
+# the connection string to the database
+connectionString: "Data Source=(local);Initial Catalog=Tracker;Integrated Security=True"
+
+# the database provider name. Default:SqlServer
+provider: SqlServer
+
+# config name to read the connection string from the user secrets file
+connectionName: "ConnectionStrings:Generator"
+
+# the user secret identifier, can be shared with .net core project
+userSecretsId: "984ef0cf-2b22-4fd1-876d-e01499da4c1f"
+
+# the directory to output the configuration. Default is current.
+outputDirectory: .\
+
+# tables to include or empty to include all
+tables:
+  - Priority
+  - Status
+  - Task
+  - User
+
+# schemas to include or empty to include all
+schemas:
+  - dbo
+
+# exclude tables or columns
+exclude:
+  # list of expressions for tables to exclude, source is Schema.TableName
+  tables:
+    - exact: dbo.SchemaVersions
+    - regex: dbo\.SchemaVersions$
+  # list of expressions for columns to exclude, source is Schema.TableName.ColumnName
+  columns:
+    - exact: dbo.SchemaVersions\.Version
+    - regex: dbo\.SchemaVersions\.Version$
+
+# how to generate entity class names from the table name. Preserve|Plural|Singular. Default: Singular
+entityNaming: Singular
+
+# how to generate relationship collections names for the entity.  Default: Plural
+relationshipNaming: Plural
+
+# Rename entities and properties with regular expressions.  Matched expressions will be removed.
+renaming:
+  entities:
+    - ^(sp|tbl|udf|vw)_
+  properties:
+    - ^{Table.Name}(?=Id|Name)
+
+#templateFilePath: ./template/dab-config1.csx 
+
+```
\ No newline at end of file
diff --git a/src/DbApiBuilderEntityGenerator/DbApiBuilderEntityGenerator.csproj b/src/DbApiBuilderEntityGenerator/DbApiBuilderEntityGenerator.csproj
index d95b1ff..3517de7 100644
--- a/src/DbApiBuilderEntityGenerator/DbApiBuilderEntityGenerator.csproj
+++ b/src/DbApiBuilderEntityGenerator/DbApiBuilderEntityGenerator.csproj
@@ -21,7 +21,7 @@
     <RepositoryType>git</RepositoryType>
     <RepositoryUrl>https://github.com/platyscript/DbApiBuilderEntityGenerator</RepositoryUrl>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
-    <Version>1.0.2-alpha</Version>  
+    <Version>1.0.3-alpha</Version>  
      <PackageReleaseNotes>
       * Net9
     </PackageReleaseNotes>