Clarify in README.md that we switched to gymnasium. (HumanCompatibleA…

…I#824)
maxijsseldijk · Dec 5, 2023 · 3649188 · 3649188
1 parent 928d576
commit 3649188
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -29,9 +29,11 @@ You can read the latest benchmark results [here](https://imitation.readthedocs.i
 ### Prerequisites
 
 - Python 3.8+
-- (Optional) OpenGL (to render Gym environments)
+- (Optional) OpenGL (to render Gymnasium environments)
 - (Optional) FFmpeg (to encode videos of renders)
 
+> Note: `imitation` is only compatible with newer [gymnasium](https://gymnasium.farama.org/) environment API and does not support the older `gym` API.
+
 ### Installing PyPI release
 
 Installing the PyPI release is the standard way to use `imitation`, and the recommended way for most users.