From 50d62a14245138a380f8889474ed0fdfb786fec0 Mon Sep 17 00:00:00 2001
From: Zero Ekkusu <94782988+ZeroEkkusu@users.noreply.github.com>
Date: Wed, 21 Aug 2024 14:05:24 +0200
Subject: [PATCH] docs: improve
---
README.md | 25 +++++++++++++++++--------
1 file changed, 17 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index a521b4f..4ae370c 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,19 @@
# SOLX
-Write Solidity AND **any other programming language** at the same time!
+Write Solidity AND **any other programming language** at the same time in Forge tests and scripts!
## 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 cannot be used for actual smart contracts.
+
+
+I have read and understood the above warning. Show me the usage instructions.
+
+
**Clone**
@@ -43,9 +49,10 @@ forge test
**Experiment**
-👉 Try it out: [`test/Example.solx`](./test/Example.solx)
+> [!NOTE]
+> Try it here: [`test/Example.solx`](./test/Example.solx)
-Specify variables to sync between Solidity and TypeScript:
+Sync variables between Solidity and TypeScript:
```solidity
uint256 a;
@@ -55,7 +62,7 @@ a++;
assertEq(a, 1);
```
-Specify variables to clone from TypeScript:
+Clone variables from TypeScript:
```solidity
uint256 a = 1;
@@ -65,16 +72,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.
+
+
## License
​
Licensed under either of