docs: module doc and readme example

Savory · Oct 3, 2024 · 4f6dce7 · 4f6dce7
1 parent 48b7414
commit 4f6dce7
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -12,7 +12,10 @@
 [Danet](https://github.com/Savory/Danet).
 
 ## Quick Start
-
+```bash
+   deno install --global -A -n danet jsr:@danet/cli
+   danet new <my-project>
+```
 [Overview & Tutorial](https://savory.github.io/Danet/openapi/introduction/)
 
 ## License

diff --git a/decorators.ts b/decorators.ts
@@ -1,3 +1,8 @@
+/**
+ * @module
+ * Provides decorators to define metadata to generate your openAPI/Swagger documentation.
+ */
+
 import { BODY_TYPE_KEY, MetadataHelper, QUERY_TYPE_KEY } from './deps.ts';
 import { Constructor } from './mod.ts';
 import { Swagger } from "./swagger.ts";

diff --git a/deno.json b/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@danet/swagger",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "exports": {
     ".":"./mod.ts",
     "./decorators": "./decorators.ts"

diff --git a/mod.ts b/mod.ts
@@ -1,3 +1,8 @@
+/**
+ * @module
+ * SwaggerModule provides methods to generate and set up Swagger documentation for a Danet application.
+ */
+
 import {
 	DanetApplication,
 	MetadataHelper,