@stingerloom/orm 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +17 -0
  2. package/package.json +10 -5
package/README.md CHANGED
@@ -2,6 +2,7 @@
2
2
  <p align="center">Decorator-driven TypeScript ORM with multi-tenancy support.</p>
3
3
 
4
4
  <p align="center">
5
+ <a href="https://www.npmjs.com/package/@stingerloom/orm"><img src="https://img.shields.io/npm/v/@stingerloom/orm" alt="npm" /></a>
5
6
  <img src="https://img.shields.io/badge/tests-1%2C405%20passed-brightgreen" alt="Tests" />
6
7
  <img src="https://img.shields.io/badge/license-MIT-blue" alt="License" />
7
8
  <img src="https://img.shields.io/badge/TypeScript-strict-3178C6?logo=typescript&logoColor=white" alt="TypeScript" />
@@ -9,6 +10,22 @@
9
10
 
10
11
  ---
11
12
 
13
+ ## Install
14
+
15
+ ```bash
16
+ npm install @stingerloom/orm reflect-metadata
17
+ ```
18
+
19
+ Install only the driver you need:
20
+
21
+ ```bash
22
+ npm install mysql2 # MySQL
23
+ npm install pg # PostgreSQL
24
+ npm install better-sqlite3 # SQLite
25
+ ```
26
+
27
+ ## Quick Start
28
+
12
29
  ```typescript
13
30
  @Entity()
14
31
  class User {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stingerloom/orm",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "A standalone, framework-agnostic TypeScript ORM that can be used with any Node.js framework",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -30,7 +30,6 @@
30
30
  "database",
31
31
  "decorator",
32
32
  "multi-tenancy",
33
- "typeorm-alternative",
34
33
  "stingerloom"
35
34
  ],
36
35
  "scripts": {
@@ -50,9 +49,15 @@
50
49
  "better-sqlite3": ">=9.0.0"
51
50
  },
52
51
  "peerDependenciesMeta": {
53
- "mysql2": { "optional": true },
54
- "pg": { "optional": true },
55
- "better-sqlite3": { "optional": true }
52
+ "mysql2": {
53
+ "optional": true
54
+ },
55
+ "pg": {
56
+ "optional": true
57
+ },
58
+ "better-sqlite3": {
59
+ "optional": true
60
+ }
56
61
  },
57
62
  "devDependencies": {
58
63
  "@types/better-sqlite3": "^7.6.13",