From 61821b0b2cb421f924deba36c074cc14bc165bd5 Mon Sep 17 00:00:00 2001
From: El De-dog-lo <3859395+fubuloubu@users.noreply.github.com>
Date: Thu, 7 Dec 2023 10:09:41 -0500
Subject: [PATCH] docs: add notes about evm version config to readme

---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index a577e65b..d4585653 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,20 @@ vyper:
   version: 0.3.7
 ```
 
+### EVM Versioning
+
+By default, `ape-vyper` will use whatever version of EVM rules are set as default in the compiler version that gets used,
+or based on what the `#pragma evm-version ...` pragma comment specifies (available post-`v0.3.10`).
+Sometimes, you might want to use a different version, such as deploying on Arbitrum or Optimism where new opcodes are not supported yet.
+If you want to require a different version of EVM rules to use in the configuration of the compiler, set it in your `ape-config.yaml` like this:
+
+```yaml
+vyper:
+  evm_version: paris
+```
+
+**NOTE**: The config value chosen will not override if a pragma is set in a contract.
+
 ### Interfaces
 
 You can not compile interface source files directly.
@@ -92,6 +106,12 @@ Ape-Vyper supports Vyper 0.3.10's [new pragma formats](https://github.com/vyperl
 #pragma version 0.3.10
 ```
 
+#### EVM Version Pragma
+
+```python
+#pragma evm-version paris
+```
+
 #### Optimization Pragma
 
 ```python