updated docs

aag1024 · Jan 10, 2025 · 14b08a4 · 14b08a4
1 parent 948fc86
commit 14b08a4
Show file tree

Hide file tree

Showing 35 changed files with 66 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # DynamoBao
 
+[![GitHub stars](https://img.shields.io/github/stars/adriangraham/dynamo-bao.svg?style=social&label=Star)](https://github.com/adriangraham/dynamo-bao)
+[![npm version](https://badge.fury.io/js/dynamo-bao.svg)](https://badge.fury.io/js/dynamo-bao)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 DynamoBao is a simple lightweight library for building DynamoDB models in JavaScript. I've used
 DynamoDB for years and generally love it, but find getting started difficult and repetitive.
 DynamoBao is the tool I wish I had when I started.

diff --git a/docs/BaoFields.BaoBaseField.html b/docs/BaoFields.BaoBaseField.html
diff --git a/docs/BaoFields.BinaryField.html b/docs/BaoFields.BinaryField.html
diff --git a/docs/BaoFields.BooleanField.html b/docs/BaoFields.BooleanField.html
diff --git a/docs/BaoFields.CounterField.html b/docs/BaoFields.CounterField.html
diff --git a/docs/BaoFields.CreateDateField.html b/docs/BaoFields.CreateDateField.html
diff --git a/docs/BaoFields.DateTimeField.html b/docs/BaoFields.DateTimeField.html
diff --git a/docs/BaoFields.FloatField.html b/docs/BaoFields.FloatField.html
diff --git a/docs/BaoFields.IntegerField.html b/docs/BaoFields.IntegerField.html
diff --git a/docs/BaoFields.ModifiedDateField.html b/docs/BaoFields.ModifiedDateField.html
diff --git a/docs/BaoFields.RelatedField.html b/docs/BaoFields.RelatedField.html
diff --git a/docs/BaoFields.StringField.html b/docs/BaoFields.StringField.html
diff --git a/docs/BaoFields.TtlField.html b/docs/BaoFields.TtlField.html
diff --git a/docs/BaoFields.UlidField.html b/docs/BaoFields.UlidField.html
diff --git a/docs/BaoFields.VersionField.html b/docs/BaoFields.VersionField.html
diff --git a/docs/BaoFields.html b/docs/BaoFields.html
diff --git a/docs/BaoModel.html b/docs/BaoModel.html
diff --git a/docs/FilterExpressionBuilder.html b/docs/FilterExpressionBuilder.html
diff --git a/docs/ObjectNotFound.html b/docs/ObjectNotFound.html
diff --git a/docs/fields.js.html b/docs/fields.js.html
diff --git a/docs/filter-expression.js.html b/docs/filter-expression.js.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/mixins_batch-loading-mixin.js.html b/docs/mixins_batch-loading-mixin.js.html
diff --git a/docs/mixins_mutation-mixin.js.html b/docs/mixins_mutation-mixin.js.html
diff --git a/docs/mixins_query-mixin.js.html b/docs/mixins_query-mixin.js.html
diff --git a/docs/model.js.html b/docs/model.js.html
diff --git a/docs/object-not-found.js.html b/docs/object-not-found.js.html
diff --git a/docs/tutorial-01-model-definitions.html b/docs/tutorial-01-model-definitions.html
diff --git a/docs/tutorial-02-query-and-filter.html b/docs/tutorial-02-query-and-filter.html
diff --git a/docs/tutorial-04-changing-models.html b/docs/tutorial-04-changing-models.html
diff --git a/docs/tutorial-05-ttl-fields.html b/docs/tutorial-05-ttl-fields.html
diff --git a/docs/tutorial-06-custom-fields.html b/docs/tutorial-06-custom-fields.html
diff --git a/docs/tutorial-07-command-line-tools.html b/docs/tutorial-07-command-line-tools.html
diff --git a/jsdoc.json b/jsdoc.json
@@ -13,7 +13,20 @@
       "include_css": ["./jsdoc.css"],
       "homepageTitle": "DynamoBao",
       "title": "DynamoBao",
-      "sections": ["Tutorials", "Namespaces", "Classes"]
+      "sections": ["Tutorials", "Namespaces", "Classes"],
+      "create_style": ".gh-button-container { position: fixed; top: 20px; right: 200px; z-index: 100; }",
+      "menu": [
+        {
+          "title": "🔗 Github",
+          "link": "https://github.com/adriangraham/dynamo-bao",
+          "target": "_blank"
+        },
+        {
+          "title": "📦 NPM",
+          "link": "https://www.npmjs.com/package/dynamo-bao",
+          "target": "_blank"
+        }
+      ]
     },
     "readme": "./README.md",
     "tutorials": "./tutorials"

diff --git a/package.json b/package.json
@@ -27,7 +27,7 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/adriangraham/dynamo-bao.git"
+    "url": "https://github.com/adriangraham/dynamo-bao"
   },
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.521.0",