sync README with latest spec

guardrails-ai · Feb 19, 2024 · 8cf6253 · 8cf6253
1 parent f1f72a1
commit 8cf6253
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-## Overview
+# Overview
 
 | Developed by | Guardrails AI |
 | --- | --- |
@@ -12,9 +12,11 @@
 
 This validator ensures that no competitors for an organization are being named. In order to use this validator, you need to provide a list of competitors that you don’t want to name.
 
-### Resources required
+### Requirements
 
-- Dependencies: `nltk`
+* Dependencies:
+    - guardrails-ai>=0.4.0
+    - nltk
 
 ## Installation
 
@@ -76,7 +78,7 @@ guard.parse("""
 """)
 ```
 
-## API Reference
+# API Reference
 
 
 **`__init__(self, competitors, on_fail="noop")`**