Add update-state to readme

GEOS-ESM · Aug 12, 2024 · d173d45 · d173d45
1 parent 28adc85
commit d173d45
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-## [2.0.0] - 2024-08-09
+## [2.0.0] - 2024-08-12
 
 ### Fixed
 

diff --git a/README.md b/README.md
@@ -27,6 +27,20 @@ brew tap gmao-si-team/packages
 brew install mepo
 ```
 
+## Transitioning from `mepo` v1.x to v2.x
+
+If you try to use mepo v2.x within a mepo v1.x repository, you will get an warning message:
+```
+Detected mepo1 style state
+Run <mepo update-state> to permanently convert to mepo2 style
+```
+
+To update your repository to work with mepo v2.x, you can run the following command:
+```
+mepo update-state
+```
+and it will convert the repository from mepo v1 pickle-state to mepo v2 json-state.
+
 ## Commands
 
 For more about the possible `mepo` commands, please see the [Mepo Commands](https://github.com/GEOS-ESM/mepo/wiki/Mepo-Commands) wiki page.