Skip to content

Commit d42eb44

Browse files
committed
docs: add CHANGELOG and LICENESE, set module name
1 parent ff89d92 commit d42eb44

File tree

5 files changed

+26
-0
lines changed

5 files changed

+26
-0
lines changed

LICENSE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
LICENSE

src/drizzle.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1+
/**
2+
* The Drizzle ORM integration for the fraci library.
3+
*
4+
* @module fraci/drizzle
5+
*/
6+
17
export * from "./drizzle/index.js";

src/index.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
/**
2+
* The main module for the fraci library, providing core utilities and types.
3+
*
4+
* @module fraci
5+
*/
6+
17
export * from "./bases.js";
28
export * from "./factory.js";
39
export type * from "./types.js";

src/prisma.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1+
/**
2+
* The Prisma ORM integration for the fraci library.
3+
*
4+
* @module fraci/prisma
5+
*/
6+
17
export * from "./prisma/index.js";

typedoc.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
"./src/drizzle.ts",
88
"./src/prisma.ts"
99
],
10+
"projectDocuments": [
11+
"CHANGELOG.md",
12+
"LICENSE.md"
13+
],
1014
"highlightLanguages": [
1115
"prisma",
1216
"shell",
@@ -19,6 +23,9 @@
1923
"hostedBaseUrl": "https://segararai.github.io/fraci/",
2024
"useHostedBaseUrlForAbsoluteLinks": true,
2125
"favicon": "public/favicon.svg",
26+
"navigation": {
27+
"includeFolders": false
28+
},
2229
"navigationLinks": {
2330
"GitHub": "https://github.com/SegaraRai/fraci",
2431
"npm": "https://www.npmjs.com/package/fraci"

0 commit comments

Comments
 (0)