Skip to content

Commit 178848a

Browse files
authored
Update README.md
1 parent dfeff2b commit 178848a

File tree

1 file changed

+8
-17
lines changed

1 file changed

+8
-17
lines changed

README.md

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,20 @@
22

33
[![Test](https://github.com/asheswook/tranjs/actions/workflows/test.yml/badge.svg)](https://github.com/asheswook/tranjs/actions/workflows/test.yml)
44

5-
**Node.js Transaction Management Framework**
5+
TranJS is a transaction management framework which provides declaretive transaction, without any ORMs.
66

7-
TranJS is a transaction management framework for Node.js, inspired by Java Hibernate's `@Transactional` annotation.
87
It is designed to provide reliable and intuitive transaction management for mission-critical safety applications and general-purpose applications.
98

10-
**This framework is now experimental and under development. Please feel free to contribute or provide feedback.**
11-
129
## Features
13-
-**Effortless Declarative Transactions**
10+
-**Declarative Transaction via Decorator**
1411
-**TypeScript Native**
1512
- 🛠️ **No Dependencies, Lightweight (15KB)**
1613
- 🔄 **Flexible Transaction Propagation**
1714

1815
## Getting Started
1916
* API Documentation is available at [here](/docs/api.md).
20-
* The [example](/examples) contains a simple example of how to use the TranJS framework.
2117
* Supported drivers are available at [here](/docs/drivers.md).
22-
23-
If you have any questions or need help, just ask!
24-
25-
## Installation
26-
27-
It should be set up for the database you want to use. See [here](/docs/drivers.md).
28-
29-
Also, you can refer to the [self-implementation](/docs/self-implement-guide.md) guide if you want to implement the driver yourself.
18+
* The [example](/examples) contains a simple example of how to use the TranJS framework.
3019

3120
## Usage
3221

@@ -59,10 +48,12 @@ Execute Query Chansu 100
5948
Commit Transaction (id: ae8wml5i78rt) # Transaction committed when transfer() finished
6049
```
6150

62-
## The reason why made this
63-
While developing software requiring robust transaction management, I needed a way to group multiple query executions into a single transaction. Initially, I used anonymous functions, referred to as _Executables_, to achieve this. However, this approach was complex, required extra boilerplate code, and made it difficult for new developers to understand.
51+
## Installation
52+
53+
It should be set up for the database you want to use. See [here](/docs/drivers.md).
6454

65-
To simplify this process, I created **tranjs**, a framework that enables transaction management in Node.js using a clean and intuitive `@Transactional` decorator, inspired by Java Hibernate.
55+
> [!NOTE]
56+
> If the driver you want to use does not exist, [you can implement it on your own.](/docs/self-implement-guide.md)
6657
6758
## LICENSE
6859

0 commit comments

Comments
 (0)