diff --git a/README.md b/README.md index 8714546..56a3bb2 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,25 @@ # CashScript Playground -The CashScript Playground is a way to write CashScript contracts and immediately interact with them in the browser. It is inspired by Ethereum's Remix, but slightly less feature-rich. +The CashScript Playground is an online IDE for writing CashScript smart contracts and immediately interact with them in the browser. The playground the easiest way to quickly get started with CashScript without any setup. The CashScript playground is inspired by Ethereum's Remix. -In the left panel you can write CashScript contracts and compile them. After compiling, a form is generated to create a new instance of this CashScript contract. It will then display some information about the contract and generate new forms to call contract functions to send BCH transactions. Press the arrow buttons to switch to a wallet view where you can generate wallets for testing purposes. +The CashScript Playground is available at [playground.cashscript.org](https://playground.cashscript.org/). -A live demo is available at [playground.cashscript.org](https://playground.cashscript.org/). +![Featured-screenhot](./screenshots/featured-screenshot.png) + +In the left panel you can write CashScript contracts and compile them. After compiling, a contract Artifact is generated which can then be used to initialise an instance of the contract, with specific contract arguments. ## Limitations Special transaction options such as OP_RETURN, hardcoded fees or relative timelocks are not supported by the playground. -The CashScript-Playground is connected to the Bitcoin Cash chipnet by default, you can get testnet coins from the [testnet faucet](https://tbch.googol.cash/). You can also connect the playground to mainnet but be sure **never to send large amounts** of money to contracts or wallets generated by the CashScript Playground! +The playground also does not support the combining multiple different smart contracts in one transaction. -## Example -![Example-0](./screenshots/nftUnlockedCovenant-0.png) +## Disclaimer + +The CashScript-Playground is connected to the Bitcoin Cash chipnet by default, you can get testnet coins from the [testnet faucet](https://tbch.googol.cash/). You can also connect the playground to mainnet but be sure **never to send large amounts** of money to contracts or wallets generated by the CashScript Playground! -![Example-1](./screenshots/nftUnlockedCovenant-1.png) +## ScreenShots +![Screenshot-1](./screenshots/screenshot-1.png) -![Example-2](./screenshots/nftUnlockedCovenant-2.png) +![Screenshot-2](./screenshots/screenshot-2.png) ## Running locally ``` diff --git a/screenshots/featured-screenshot.png b/screenshots/featured-screenshot.png new file mode 100644 index 0000000..40f74e7 Binary files /dev/null and b/screenshots/featured-screenshot.png differ diff --git a/screenshots/nftUnlockedCovenant-0.png b/screenshots/nftUnlockedCovenant-0.png deleted file mode 100644 index 518bb3e..0000000 Binary files a/screenshots/nftUnlockedCovenant-0.png and /dev/null differ diff --git a/screenshots/nftUnlockedCovenant-1.png b/screenshots/nftUnlockedCovenant-1.png deleted file mode 100644 index 96b79b9..0000000 Binary files a/screenshots/nftUnlockedCovenant-1.png and /dev/null differ diff --git a/screenshots/nftUnlockedCovenant-2.png b/screenshots/nftUnlockedCovenant-2.png deleted file mode 100644 index 606470f..0000000 Binary files a/screenshots/nftUnlockedCovenant-2.png and /dev/null differ diff --git a/screenshots/screenshot-1.png b/screenshots/screenshot-1.png new file mode 100644 index 0000000..7ab21b2 Binary files /dev/null and b/screenshots/screenshot-1.png differ diff --git a/screenshots/screenshot-2.png b/screenshots/screenshot-2.png new file mode 100644 index 0000000..20c6a1f Binary files /dev/null and b/screenshots/screenshot-2.png differ