Skip to content

Commit b276707

Browse files
docs: update README
1 parent 288dddc commit b276707

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ First install the required packages via:
2525
npm install typedi reflect-metadata
2626
```
2727

28-
Import the `reflect-metadata` package in the **first line** of your application:
28+
Import the `reflect-metadata` package at the **first line** of your application:
2929

3030
```ts
3131
import 'reflect-metadata';
3232

3333
// Your other imports and initialization code
34-
// comes here after you imported reflect-metadata package!
34+
// comes here after you imported the reflect-metadata package!
3535
```
3636

37-
Enable emitting decorator metadata in your Typescript config, add these two lines to your `tsconfig.json` file:
37+
As a last step, you need to enable emitting decorator metadata in your Typescript config. Add these two lines to your `tsconfig.json` file under the `compilerOptions` key:
3838

3939
```json
4040
"emitDecoratorMetadata": true,
@@ -82,3 +82,7 @@ The detailed usage guide and API documentation for the project can be found:
8282

8383
[docs-stable]: https://docs.typestack.community/typedi/
8484
[docs-development]: https://docs.typestack.community/typedi/v/develop/
85+
86+
## Contributing
87+
88+
Please read our [contributing guidelines](./CONTRIBUTING.md) to get started.

0 commit comments

Comments
 (0)