Add warning notice for installations (#524)

* add warning notice for installations * Update README.md Co-authored-by: Martín Triay <martriay@gmail.com> * add explanation to block Co-authored-by: Martín Triay <martriay@gmail.com>
OpenZeppelin · Nov 29, 2022 · ace83f8 · ace83f8
1 parent dbb1a3d
commit ace83f8
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -48,6 +48,9 @@ nile init
 pip install openzeppelin-cairo-contracts
 ```
 
+> ⚠️ Warning! ⚠️  
+Installing directly the `main` branch may contain incomplete or breaking implementations, download [official releases](https://github.com/OpenZeppelin/cairo-contracts/releases/) only.
+
 ### Use a basic preset
 
 Presets are ready-to-use contracts that you can deploy right away. They also serve as examples of how to use library modules. [Read more about presets](https://docs.openzeppelin.com/contracts-cairo/0.5.1/extensibility#presets).

diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -46,6 +46,9 @@ nile init
 pip install openzeppelin-cairo-contracts
 ----
 
+WARNING: Installing directly through GitHub may contain incomplete or breaking implementations.
+While we aim not to introduce such changes, we still strongly recommend installing through https://github.com/OpenZeppelin/cairo-contracts/releases/[official releases].
+
 === Use a basic preset
 
 Presets are ready-to-use contracts that you can deploy right away.