diff --git a/README.md b/README.md index df2cd67..93a6f69 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Metadata Reflection API -NOTE: Now that both [Decorators](https://github.com/tc39/proposal-decorators) and +NOTE: Now that both [Decorators](https://github.com/tc39/proposal-decorators) and [Decorator Metadata](https://github.com/tc39/proposal-decorator-metadata) have achieved Stage 3 within TC39, the API proposed below is no longer being considered for standardization. However, this package will continue to support projects that leverage TypeScript's legacy `--experimentalDecorators` option as some projects may not be able to migrate to use standard decorators. -* [Detailed proposal][metadata-spec] +- [Detailed proposal][metadata-spec] ## Installation @@ -17,6 +17,7 @@ npm install reflect-metadata ## Usage ### ES Modules in NodeJS/Browser, TypeScript/Babel, Bundlers + ```ts // - Modifies global `Reflect` object (or defines one in ES5 runtimes). // - Supports ESM and CommonJS. @@ -31,6 +32,7 @@ import "reflect-metadata/lite"; ``` ### CommonJS + ```ts // - Modifies global `Reflect` object (or defines one in ES5 runtimes). // - Contains internal polyfills for `Map`, `Set`, and `WeakMap` for older runtimes. @@ -43,7 +45,9 @@ require("reflect-metadata/lite"); ``` ### In the Browser via ` -