feat: update readme

nailyjs · Nov 3, 2024 · c2e2070 · c2e2070
1 parent b5d92c5
commit c2e2070
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -6,6 +6,7 @@
     "bumpp",
     "Containerable",
     "Fastly",
+    "inversify",
     "Naily",
     "nailyjs",
     "paramtypes",

diff --git a/packages/ioc/src/index.ts b/packages/ioc/src/index.ts
@@ -3,6 +3,22 @@
  * This is the core package of naily, which provides the basic IOC features. It is a lightweight、across-platform and easy-to-use IOC meta framework for TypeScript.
  *
  * @module
+ * @example
+ * ```typescript
+ * import { Container, Injectable, Inject } from '@nailyjs/ioc'
+ *
+ * Injectable()
+ * export class FooService {}
+ *
+ * Injectable()
+ * export class BarService {
+ *  constructor(private fooService: FooService) {}
+ * }
+ *
+ * // No similar inversify.js, container will automatically inspect the dependencies of the constructors.
+ * const container = new Container()
+ * console.log(container.getContainer()) // It is a Map object, which contains all the registered services.
+ * ```
  */
 
 export * from './apply-decorator'