build(doc): initialized project documents

Author: fenying

.gitignore

@@ -8,3 +8,4 @@ tsconfig.tsbuildinfo
 *.ts.map
 !commitlint.config.js
 !/eslint.config.js
+/tmp/

README.md

@@ -14,12 +14,38 @@ The utility functions/classes/constants for JavaScript/TypeScript.
 - TypeScript v5.0.0 (or newer)
 - Node.js v18.0.0 (or newer)
 
+## Namespaces
+
+The [bundle package `@litert/utils`](https://www.npmjs.com/package/@litert/utils) includes all utility functions/classes/constants, exported each sub-package as a namespace.
+
+- `Root Namespace`
+
+    These sub-packages are exported at the root namespace of the bundle package:
+    - [@litert/utils-flow-control](https://www.npmjs.com/package/@litert/utils-flow-control)
+    - [@litert/utils-ts-types](https://www.npmjs.com/package/@litert/utils-ts-types)
+
+- `Namespace Array` (Sub-package: [@litert/utils-array](https://www.npmjs.com/package/@litert/utils-array))
+- `Namespace Network` (Sub-package: [@litert/utils-network](https://www.npmjs.com/package/@litert/utils-network))
+- `Namespace Number` (Sub-package: [@litert/utils-number](https://www.npmjs.com/package/@litert/utils-number))
+- `Namespace Object` (Sub-package: [@litert/utils-object](https://www.npmjs.com/package/@litert/utils-object))
+- `Namespace String` (Sub-package: [@litert/utils-string](https://www.npmjs.com/package/@litert/utils-string))
+
 ## Installation
 
 ```sh
 npm i @litert/utils --save
 ```
 
+## Documentation
+
+- [Array](https://litert.org/projects/utils.js/api-docs/array/)
+- [Flow Control](https://litert.org/projects/utils.js/api-docs/flow-control/)
+- [Network](https://litert.org/projects/utils.js/api-docs/network/)
+- [Number](https://litert.org/projects/utils.js/api-docs/number/)
+- [Object](https://litert.org/projects/utils.js/api-docs/object/)
+- [String](https://litert.org/projects/utils.js/api-docs/string/)
+- [Typescript Types](https://litert.org/projects/utils.js/api-docs/ts-types/)
+
 ## License
 
 This library is published under [Apache-2.0](https://github.com/litert/utils.js/blob/master/LICENSE) license.

package-lock.json

@@ -30,6 +30,7 @@
     "@litert/ottoia": "^0.4.4",
     "@types/node": "^22.10.2",
     "husky": "^9.1.7",
+    "typedoc": "^0.28.5",
     "typescript": "^5.7.2"
   },
   "ottoia": {

package.json

@@ -15,8 +15,8 @@
   "homepage": "https://github.com/litert/utils.js#readme",
   "scripts": {
     "ottoia:clean": "rm -rf lib tsconfig.tsbuildinfo",
-    "ottoia:prepublish": "cp ../../LICENSE ./",
-    "ottoia:postpublish": "rm LICENSE",
+    "ottoia:prepublish": "cp ../../LICENSE ./ && cp ../../LICENSE ./README.md",
+    "ottoia:postpublish": "rm LICENSE README.md",
     "prepublishOnly": "echo \"Please use ottoia publishing this package!\"; exit 1;"
   },
   "license": "Apache-2.0",

packages/bundle/README.md

@@ -20,6 +20,10 @@ The utility functions/classes/constants about arrays for JavaScript/TypeScript.
 npm i @litert/utils-array --save
 ```
 
+## Documentation
+
+- [en-US](https://litert.org/projects/utils.js/api-docs/array/)
+
 ## License
 
 This library is published under [Apache-2.0](https://github.com/litert/utils.js/blob/master/LICENSE) license.

packages/bundle/package.json

@@ -20,6 +20,10 @@ The utility functions/classes/constants about flow-controlling for JavaScript/Ty
 npm i @litert/utils-flow-control --save
 ```
 
+## Documentation
+
+- [en-US](https://litert.org/projects/utils.js/api-docs/flow-control/)
+
 ## License
 
 This library is published under [Apache-2.0](https://github.com/litert/utils.js/blob/master/LICENSE) license.