Skip to content

Commit d73f898

Browse files
committed
services: add skeleton README.md and update package.json as well
1 parent 429f7b5 commit d73f898

File tree

2 files changed

+28
-4
lines changed

2 files changed

+28
-4
lines changed

packages/services/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# @effect-mongodb/services
2+
3+
Effect services for effect-mongodb
4+
5+
## Install
6+
7+
```shell
8+
pnpm install @effect-mongodb/services effect-mongodb effect mongodb
9+
```
10+
11+
Note that `effect-mongodb`, `effect`, and `mongodb` are requested as peer dependencies.
12+
13+
## Usage
14+
15+
TODO
16+
17+
## Development
18+
19+
Useful links to explore mongodb package:
20+
21+
- https://mongodb.github.io/node-mongodb-native/Next/classes/Collection.html (with links to source code)
22+
- https://www.mongodb.com/docs/v7.0/reference/method/js-collection/

packages/services/package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
"name": "@effect-mongodb/services",
33
"private": true,
44
"author": "doubleloop.io",
5-
"version": "0.0.4",
5+
"version": "0.0.1",
66
"type": "module",
77
"license": "MIT",
8-
"description": "A MongoDB toolkit for Effect",
8+
"description": "Effect services for effect-mongodb",
99
"homepage": "https://github.com/doubleloop-io/effect-mongodb",
1010
"repository": {
1111
"type": "git",
@@ -19,13 +19,15 @@
1919
"typescript",
2020
"mongodb",
2121
"effect",
22-
"functional-programming"
22+
"functional-programming",
23+
"effect-mongodb"
2324
],
2425
"keywords": [
2526
"typescript",
2627
"mongodb",
2728
"effect",
28-
"functional-programming"
29+
"functional-programming",
30+
"effect-mongodb"
2931
],
3032
"publishConfig": {
3133
"access": "public",

0 commit comments

Comments
 (0)