From f9203521ca5e3129836d93f774a48325a00b9594 Mon Sep 17 00:00:00 2001
From: Zero Ekkusu <94782988+ZeroEkkusu@users.noreply.github.com>
Date: Wed, 21 Aug 2024 15:26:30 +0200
Subject: [PATCH] chore: rm .env.example

---
 .env.example |  1 -
 README.md    | 26 ++++++++++++++++----------
 2 files changed, 16 insertions(+), 11 deletions(-)
 delete mode 100644 .env.example

diff --git a/.env.example b/.env.example
deleted file mode 100644
index 0f8f543..0000000
--- a/.env.example
+++ /dev/null
@@ -1 +0,0 @@
-ETHERSCAN_API_KEY=
\ No newline at end of file
diff --git a/README.md b/README.md
index a521b4f..2d66836 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,19 @@
 # SOLX
 
-Write Solidity AND **any other programming language** <ins>at the same time</ins>!
+Write Solidity AND **any other programming language** <ins>at the same time</ins> in Foundry tests and scripts!
 
 <img src="./demo.gif"></img>
 
 ## Usage
 
-> [!IMPORTANT]
-> Proof of concept. For research purposes only.
+> [!CAUTION]
+> This is an experimental proof of concept. Do not use in development or production environments.
+> SOLX is designed to work exclusively in Foundry's local EVM and <ins>cannot be used for actual smart contracts</ins>.
+
+<details>
+<summary><b>I have read and understood the above warning. Show me the usage instructions.</b></summary>
+
+<br>
 
 **Clone**
 
@@ -27,8 +33,6 @@ soldeer install & bun install
 source solx/hooks.sh
 ```
 
-This will hook SOLX transpiler to Forge.
-
 **Build**
 
 ```shell
@@ -43,9 +47,9 @@ forge test
 
 **Experiment**
 
-👉 Try it out: [`test/Example.solx`](./test/Example.solx)
+[Playground ↗](./test/Example.solx)
 
-Specify variables to sync between Solidity and TypeScript:
+Sync variables between Solidity and TypeScript:
 
 ```solidity
 uint256 a;
@@ -55,7 +59,7 @@ a++;
 assertEq(a, 1);
 ```
 
-Specify variables to clone from TypeScript:
+Clone variables from TypeScript:
 
 ```solidity
 uint256 a = 1;
@@ -65,16 +69,18 @@ const b = 1;
 assertEq(a, b);
 ```
 
-Use `console.log` in TypeScript:
+`console.log` in TypeScript:
 
 ```solidity
 // @typescript-start ()
-console.log('👀');
+console.log("solx");
 // @typescript-end ()
 ```
 
 Only TypeScript is supported currently.
 
+</details>
+
 ## License
 ​
 Licensed under either of