Skip to content

Commit dadef53

Browse files
committed
Updated README.md
1 parent 122be66 commit dadef53

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
1+
![Alt](https://github.com/dkildar/immutable-entity-manager/actions/workflows/main.yml/badge.svg)
2+
[![npm version](https://badge.fury.io/js/react-mitt-wrapper.svg)](https://badge.fury.io/js/immutable-entity-manager)
23
# Immutable entites manager
34

45

56
This initiative enables developers to leverage entities in Node.js projects, whether on the client side or in any other Node.js environment.
67

7-
## Installation
8+
## 🔨 Installation
89

910

1011
```bash
@@ -14,7 +15,7 @@ npm install immutable-entity-manager
1415
yarn add immutable-entity-manager
1516
```
1617

17-
## Usage/Examples
18+
## 🗒️ Usage/Examples
1819
This package is built on the foundation of the manager and builder patterns. Each immutable entity has its own dedicated manager, designed to assist in data parsing. The manager, in turn, yields a builder class responsible for handling various tasks such as processing decorators, applying properties, and more.
1920

2021
This package uses Typescript under-the-hood which means that it generates return type, properties name, etc.
@@ -42,7 +43,7 @@ expect(person.birthDate).toBeInstanceOf(Date)
4243
```
4344

4445

45-
## API Reference
46+
## 📑 API Reference
4647

4748
### Decorators
4849
- `@ImmutableEntity` – mark a class as immutable entity;
@@ -82,7 +83,7 @@ Builder allow to choose conversion of properties: camel to snake or viceversa. `
8283
```typescript
8384
builder.withOptions({ camelToSnakeCase: true })
8485
```
85-
## Roadmap
86+
## 🙌 Roadmap
8687

8788
- Add transformation of property before parsing or in `withProperty`;
8889

0 commit comments

Comments
 (0)