Add clarification about breaking change

CHANGELOG.md

@@ -1,18 +1,17 @@
 ## v1.0.0
 
-* Enhancements
-  * Add `update/5` for handling more complex update queries like multiple upserts.
-  * Verify support with MongoDB 4.4 and 5.0
+* BREAKING CHANGES
+- `Mongo.find_one_and_replace/5`, `Mongo.find_one_and_update/5` now return `{:ok, Mongo.FindAndModifyResult{:value, :matched_count, :upserted_id, :updated_existing}}` instead of `{:ok, doc}`.  The change should be rather mechanical as `value` is the same as `doc` only wrapped in a struct containing other information about the write.
 
 * Internal Improvements
   * Added CI via Github actions
 
 * Possible incompatibilities
   * Bump supported OTP version to v24
 
-## v0.6.0-dev
-
 * Enhancements
+  * Add `update/5` for handling more complex update queries like multiple upserts.
+  * Add support with MongoDB 4.4 and 5.0
   * Add support for MongoDB sessions
   * Add support for transactions
   * Add support for hiding configuration options from logs

README.md

@@ -4,9 +4,14 @@
 
 [Documentation for MongoDB is available online](http://hexdocs.pm/mongodb/).
 
-## Features
+## 1.0.0 Released: March 22, 2023
+
+There's one breaking change!
+- `Mongo.find_one_and_replace/5`, `Mongo.find_one_and_update/5` now return `{:ok, Mongo.FindAndModifyResult{:value, :matched_count, :upserted_id, :updated_existing}}` instead of `{:ok, doc}`
+  The change should be rather mechanical.
 
-  * Supports MongoDB versions 3.4, 3.6, 4.0, 4.2, 4.4, 5.0 (on 1.0-beta)
+## Features
+  * Supports MongoDB versions 3.4, 3.6, 4.0, 4.2, 4.4, 5.0
   * Connection pooling (through `db_connection`)
   * Streaming cursors
   * Performant ObjectID generation
@@ -16,17 +21,9 @@
   * Replica sets
   * Sessions and transactions
 
-## Immediate Roadmap
-
-  * Make sure requests don't go over the 16 MiB limit
-  * New 2.6 write queries and bulk writes
 
 ## Tentative Roadmap
-
   * Use meta-driver test suite
-  * Server selection / Read preference
-    - https://www.mongodb.com/blog/post/server-selection-next-generation-mongodb-drivers
-    - http://docs.mongodb.org/manual/reference/read-preference
 
 ## Data representation