Skip to content

Commit b175282

Browse files
crashmax-devcrashmax-dev
committed
chore: update package.json and readme.md
1 parent 246bb60 commit b175282

File tree

7 files changed

+89
-11
lines changed

7 files changed

+89
-11
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# stenodb [![](https://img.shields.io/npm/v/stenodb)](https://www.npmjs.org/package/stenodb)
22

3-
> ✍ Easy to use local JSON database. Ready to use with [LocalStorage](https://developer.mozilla.org/ru/docs/Web/API/Window/localStorage), [SessionStorage](https://developer.mozilla.org/ru/docs/Web/API/Window/sessionStorage) and [Node.js](https://nodejs.org).
3+
> ✍ Easy to use local JSON database. Ready to use in browser (localStorage, sessionStorage) and Node.js.
44
55
## Install
66

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,6 @@
2727
},
2828
"engines": {
2929
"node": ">=14.16"
30-
}
30+
},
31+
"packageManager": "[email protected]"
3132
}

‎packages/browser/package.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"name": "@stenodb/browser",
3+
"description": "✍ Easy to use local JSON database",
34
"version": "0.0.0",
45
"type": "module",
56
"files": [
@@ -17,6 +18,31 @@
1718
".": "./dist/index.js",
1819
"./types": "./dist/types.js"
1920
},
21+
"author": {
22+
"name": "Vitalij Ryndin",
23+
"email": "[email protected]",
24+
"url": "https://crashmax.ru"
25+
},
26+
"license": "MIT",
27+
"homepage": "https://github.com/crashmax-dev/stenodb/packages/browser#readme",
28+
"repository": {
29+
"type": "git",
30+
"url": "git+https://github.com/crashmax-dev/stenodb.git"
31+
},
32+
"bugs": {
33+
"url": "https://github.com/crashmax-dev/stenodb/issues"
34+
},
35+
"keywords": [
36+
"db",
37+
"database",
38+
"browser",
39+
"local",
40+
"localStorage",
41+
"sessionStorage",
42+
"class-transformer",
43+
"JSON",
44+
"ESM"
45+
],
2046
"scripts": {
2147
"dev": "tsc --watch",
2248
"build": "del-cli dist && tsc",

‎packages/node/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @stenodb/node [![](https://img.shields.io/npm/v/@stenodb/node)](https://www.npmjs.org/package/@stenodb/node)
22

3-
> ✍ Easy to use local JSON database for [Node.js](https://nodejs.org).
3+
> ✍ Easy to use local JSON database.
44
55
## Install
66

‎packages/node/package.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"name": "@stenodb/node",
3+
"description": "✍ Easy to use local JSON database",
34
"version": "0.0.0",
45
"type": "module",
56
"files": [
@@ -17,6 +18,28 @@
1718
".": "./dist/index.js",
1819
"./types": "./dist/types.js"
1920
},
21+
"author": {
22+
"name": "Vitalij Ryndin",
23+
"email": "[email protected]",
24+
"url": "https://crashmax.ru"
25+
},
26+
"license": "MIT",
27+
"homepage": "https://github.com/crashmax-dev/stenodb/packages/node#readme",
28+
"repository": {
29+
"type": "git",
30+
"url": "git+https://github.com/crashmax-dev/stenodb.git"
31+
},
32+
"bugs": {
33+
"url": "https://github.com/crashmax-dev/stenodb/issues"
34+
},
35+
"keywords": [
36+
"db",
37+
"database",
38+
"local",
39+
"class-transformer",
40+
"JSON",
41+
"ESM"
42+
],
2043
"scripts": {
2144
"dev": "tsc --watch",
2245
"build": "del-cli dist && tsc",

‎packages/stenodb/README.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# stenodb [![](https://img.shields.io/npm/v/stenodb)](https://www.npmjs.org/package/stenodb)
22

3-
> ✍ Easy to use local JSON database. Ready to use with [LocalStorage](https://developer.mozilla.org/ru/docs/Web/API/Window/localStorage), [SessionStorage](https://developer.mozilla.org/ru/docs/Web/API/Window/sessionStorage) and Node.js.
3+
> ✍ Easy to use local JSON database. Ready to use in browser (localStorage, sessionStorage) and Node.js.
44
55
## Install
66

@@ -16,20 +16,20 @@ yarn add stenodb
1616
pnpm add stenodb
1717
```
1818

19-
| Package | Version | Description |
19+
| Package | Version | Platform |
2020
| ------- | ------ | ----------- |
21-
| [stenodb](./packages/stenodb) | [![](https://img.shields.io/npm/v/stenodb)](https://npm.im/stenodb) | Meta package |
22-
| [@stenodb/node](./packages/node) | [![](https://img.shields.io/npm/v/@stenodb/node)](https://npm.im/@stenodb/node) | ... |
23-
| [@stenodb/browser](./packages/browser) | [![](https://img.shields.io/npm/v/@stenodb/browser)](https://npm.im/@stenodb/browser) | ... |
21+
| [stenodb](./packages/stenodb) | [![](https://img.shields.io/npm/v/stenodb)](https://npm.im/stenodb) | Reexports packages |
22+
| [@stenodb/node](./packages/node) | [![](https://img.shields.io/npm/v/@stenodb/node)](https://npm.im/@stenodb/node) | Node.js |
23+
| [@stenodb/browser](./packages/browser) | [![](https://img.shields.io/npm/v/@stenodb/browser)](https://npm.im/@stenodb/browser) | Browser |
2424

2525
## Usage
2626

2727
> **Warning**\
2828
> stenodb is a pure ESM package. If you're having trouble using it in your project, please [read this](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).
2929
30-
3130
### Database entities
3231
```typescript
32+
// entities.ts
3333
import { Type } from 'class-transformer'
3434

3535
export class Users {
@@ -70,7 +70,8 @@ export class Post {
7070

7171
```typescript
7272
import 'reflect-metadata'
73-
import { join } from 'node:path'
73+
import { dirname, resolve } from 'node:path'
74+
import { fileURLToPath } from 'node:url'
7475
import { AsyncWriter, NodeDatabase } from '@stenodb/node'
7576
import { Users, User, Post } from './entities.js'
7677

@@ -100,12 +101,13 @@ databaseUsers.data?.users[0]?.addPost(new Post('Lorem ipsum'))
100101
databaseUsers.write()
101102
```
102103

103-
## Related
104+
## Credits
104105

105106
- [steno](https://github.com/typicode/steno) - Specialized fast async file writer.
106107
- [class-transformer](https://github.com/typestack/class-transformer) - Decorator-based transformation, serialization, and deserialization between objects and classes.
107108
- [class-validator](https://github.com/typestack/class-validator) - Decorator-based property validation for classes.
108109
- [json-difference](https://github.com/lukascivil/json-difference) - A simple way to find the difference between two objects or json diff.
110+
- [tslog](https://github.com/fullstack-build/tslog) - Universal Logger for TypeScript and JavaScript.
109111

110112
## License
111113

‎packages/stenodb/package.json‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
22
"name": "stenodb",
3+
"description": "✍ Easy to use local JSON database",
34
"version": "0.0.0",
45
"type": "module",
56
"files": [
@@ -29,6 +30,31 @@
2930
"./browser": "./dist/browser.js",
3031
"./browser/types": "./dist/browser-types.js"
3132
},
33+
"author": {
34+
"name": "Vitalij Ryndin",
35+
"email": "[email protected]",
36+
"url": "https://crashmax.ru"
37+
},
38+
"license": "MIT",
39+
"homepage": "https://github.com/crashmax-dev/stenodb#readme",
40+
"repository": {
41+
"type": "git",
42+
"url": "git+https://github.com/crashmax-dev/stenodb.git"
43+
},
44+
"bugs": {
45+
"url": "https://github.com/crashmax-dev/stenodb/issues"
46+
},
47+
"keywords": [
48+
"db",
49+
"database",
50+
"browser",
51+
"local",
52+
"localStorage",
53+
"sessionStorage",
54+
"class-transformer",
55+
"JSON",
56+
"ESM"
57+
],
3258
"scripts": {
3359
"dev": "tsc --watch",
3460
"build": "del-cli dist && tsc",

0 commit comments

Comments
 (0)