Merge pull request #46 from dsdavis4/docs_update

Docs update
dsdavis4 · Mar 30, 2024 · 93ecb32 · 93ecb32
2 parents 6271466 + 4015a74
commit 93ecb32
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ yarn add dyna-record
 
 ## Defining Entities
 
-Entities in Dyna-Record represent your DynamoDB table structures and relationships. Each entity corresponds to a DynamoDB table.
+Entities in Dyna-Record represent your DynamoDB table structure and relationships. Think of each entity as a table in a relational database, even though they will be represented on a single table.
 
 ### Table
 
@@ -128,9 +128,8 @@ class Student extends MyTable {
 
 @Entity
 class Course extends MyTable {
-  ...
+  /// ...
 }
-
 ```
 
 ### Attributes

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "dyna-record",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "Typescript Object Relational Mapper (ORM) for Dynamo",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",