Skip to content
This repository has been archived by the owner on Oct 2, 2024. It is now read-only.

Commit

Permalink
docs: Mention the end of the prototypal phase & the repository archival
Browse files Browse the repository at this point in the history
  • Loading branch information
CLOVIS-AI committed Oct 2, 2024
1 parent 13bb723 commit d86c68b
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

> _Pronounced "cat-mongo"._
> **KtMongo was intended as a prototype. It has reached its objectives.** [Further development has been transferred to OpenSavvy](https://gitlab.com/opensavvy/ktmongo).
In 2016, Julien Buret created KMongo, a Kotlin driver for MongoDB, based on the official Java driver. KMongo added a lot of syntax sugar, making complex queries much more readable and less error-prone thanks to improved type safety:
```java
// Official Java driver
Expand Down Expand Up @@ -46,7 +48,9 @@ To learn more about the changes we have made, see [the KMongo migration guide](d

## What's the current state of the project?

This project is currently a **prototype**. Many features are missing, and implemented features may change at any time. Use at your own risk!
This project is a **prototype**.

Development has been transferred to [OpenSavvy](https://gitlab.com/opensavvy/ktmongo) (with the same license).

## Where can I learn more?

Expand Down
4 changes: 4 additions & 0 deletions docs/website/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
template: home.html
---

# Project status

This repository was a prototype for a possible new DSL. The prototype phase has ended, and the project has been transferred to [OpenSavvy](https://gitlab.com/opensavvy/ktmongo).

# Towards the future of MongoDB in Kotlin

In 2016, Julien Buret created [KMongo](https://github.com/Litote/kmongo), a Kotlin driver for MongoDB based on the official Java driver. KMongo added a lot of syntax sugar, making complex queries much more readable and less error-prone thanks to improved type safety:
Expand Down
2 changes: 1 addition & 1 deletion docs/website/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: KtMongo (experimental)
site_name: KtMongo (prototype)
site_author: 4SH & contributors
site_description: >
Towards the future of MongoDB in Kotlin.
Expand Down

0 comments on commit d86c68b

Please sign in to comment.