Skip to content

Commit 5dd91cd

Browse files
committed
docs: review and improve root README (#10)
1 parent 9935dfc commit 5dd91cd

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

README.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,41 @@
22

33
A [MongoDB](https://github.com/mongodb/node-mongodb-native) toolkit for [Effect](https://github.com/Effect-TS/effect/).
44

5+
[effect-mongodb](packages/effect-mongodb/README.md) is the core package that provides effectful APIs to work
6+
with MongoDB.
7+
8+
## MongoDB driver compatibility
9+
10+
We adhere to the [MongoDB driver compatibility](https://www.mongodb.com/docs/drivers/node/current/compatibility/)
11+
guidelines, so minor releases might break compatibility with older MongoDB servers.
12+
13+
For example, upgrading the Node.js driver from 6.8 to 6.10 will make it incompatible with MongoDB server 3.6.
14+
15+
## Roadmap
16+
17+
- [ ] [@effect-mongodb/services](packages/services/README.md) package to provide Effect services/layers to use with
18+
`effect-mongodb`
19+
520
## Contributing
621

7-
Take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) guide.
22+
Take a look at the [CONTRIBUTING.md](CONTRIBUTING.md) guidelines.
23+
24+
### Found a Bug?
25+
26+
If you find a bug in the source code, you can help us
27+
by [submitting an issue](https://github.com/doubleloop-io/effect-mongodb/issues/new) to our GitHub Repository. Even
28+
better, you can submit a Pull Request with a fix.
29+
30+
### Missing a Feature?
31+
32+
You can request a new feature
33+
by [submitting a discussion](https://github.com/doubleloop-io/effect-mongodb/discussions/new/choose) to
34+
our GitHub Repository.
35+
If you would like to implement a new feature, please consider the size of the change and reach out to
36+
better coordinate our efforts and prevent duplication of work.
37+
38+
## License
39+
40+
`effect-mongodb` is made available under the terms of the MIT License.
41+
42+
See the [LICENSE](LICENSE) file for license details.

0 commit comments

Comments
 (0)