Skip to content

Commit 472aefb

Browse files
authored
update readme (#224)
1 parent c9beb39 commit 472aefb

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

readme.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,15 @@
22
[![Twitter Follow](https://img.shields.io/twitter/follow/Scroll_ZKP?style=social)](https://twitter.com/Scroll_ZKP)
33
[![Discord](https://img.shields.io/discord/984015101017346058?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/scroll)
44

5-
> [!WARNING]
6-
> Scroll SDK is experimental software and although ready for testnets, is not yet fully configured for production usage.
7-
85
## Introduction
96

107
Scroll SDK allows anyone to quickly deploy an instance of the Scroll zkEVM and its rollup architecture for deploying an L2 on Ethereum.
118

12-
For more information, please see the [Scroll SDK Documentation](https://docs.scroll.io/en/sdk/).
9+
For more information, please see the [Scroll SDK Documentation](https://docs.scroll.io/en/sdk/) or our [launch announcement](https://scroll.io/blog/scroll-sdk-and-gadgets-building-the-foundation-for-ethereums-multichain-future).
1310

1411
## Repo
1512
This repo contains:
16-
- `ansible/playbooks`: Code for deploying provers on new machines(experimental)
13+
- `ansible/playbooks`: Code for deploying provers on new machines (experimental)
1714
- `charts/`: Helm charts used in deplying a Scroll SDK based chain using Kubernetes
1815
- `custom-images/`: Docker images used for running a local devnet and as building base images
1916
- `devnet/`: A quick start, basic configuration for setting up a local devnet
@@ -25,10 +22,25 @@ Additional SDK tooling is available in our [scroll-sdk-cli](https://www.github.c
2522

2623
To get started using the repo, checkout our guides on running [a local devnet deployment](https://docs.scroll.io/en/sdk/guides/devnet-deployment/), [an alt-gas token testnet on Digital Ocean](https://docs.scroll.io/en/sdk/guides/digital-ocean-alt-gas-token/), an [AWS deployment](https://docs.scroll.io/en/sdk/guides/aws-deployment/), or see our [production deployment](https://docs.scroll.io/en/sdk/guides/production-deployment/) page.
2724

25+
## Third-Party Scroll SDK Charts
26+
27+
> [!NOTE]
28+
> The following charts are developed and maintained by third parties. Please use with caution.
29+
30+
Proving Services:
31+
- [Sindri](https://github.com/Sindri-Labs/sindri-scroll-sdk/)
32+
33+
## Other Scroll SDK Repos
34+
35+
- [Scroll SDK CLI](https://www.github.com/scroll-tech/scroll-sdk-cli)
36+
- [Scroll Proving SDK](https://www.github.com/scroll-tech/scroll-proving-sdk)
37+
2838
## Contributing
2939

3040
The SDK is currently under heavy development, so if you wish to contribute, we recommend reaching out and coordinating closely with the Scroll team.
3141

42+
If you want to make custom modifications to any service, you can follow our guide on [Customizing SDK Components](https://docs.scroll.io/en/sdk/guides/customizing-sdk-components/).
43+
3244
## License
3345

3446
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.

0 commit comments

Comments
 (0)