Skip to content

Commit dd9c416

Browse files
authored
update readme and remove old bash script (#194)
1 parent e4efd0c commit dd9c416

File tree

2 files changed

+11
-164
lines changed

2 files changed

+11
-164
lines changed

create-env-files.sh

Lines changed: 0 additions & 157 deletions
This file was deleted.

readme.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,26 @@
99

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

12-
For more information, please see this [Early Access Preview Documentation](https://scroll-sdk-init.docs.scroll.xyz/en/sdk/).
12+
For more information, please see the [Scroll SDK Documentation](https://docs.scroll.io/en/sdk/).
1313

1414
## Repo
1515
This repo contains:
16-
- `charts/`: Helm charts for creating a Scroll SDK based chain using Kubernetes
1716
- `ansible/playbooks`: Code for deploying provers on new machines(experimental)
18-
- `custom-images/`: Docker images used for devnet and as base images
19-
- `devnet/`: A basic configuration for setting up a local devnet
17+
- `charts/`: Helm charts used in deplying a Scroll SDK based chain using Kubernetes
18+
- `custom-images/`: Docker images used for running a local devnet and as building base images
19+
- `devnet/`: A quick start, basic configuration for setting up a local devnet
2020
- `examples/`: Template files for use in your SDK project and helper scripts
2121

22-
Additional SDK tooling is available in our [scroll-sdk-cli](https://www.npmjs.com/package/scroll-sdk-cli) repo. This can also be installed locally by running `npm i -g scroll-sdk-cli` with node >= 18. More documentation for its usage is [here](https://scroll-sdk-init.docs.scroll.xyz/en/sdk/).
22+
Additional SDK tooling is available in our [scroll-sdk-cli](https://www.github.com/scroll-tech/scroll-sdk-cli) repo. This can also be installed locally by running `npm i -g scroll-sdk-cli` with node >= 18. More examples of its usage can be found in the deployment guides [here](https://scroll-sdk-init.docs.scroll.xyz/en/sdk/).
2323

2424
## Get Started
2525

26-
To get started using the repo, checkout our guides on running [a local devnet deployment](https://scroll-sdk-init.docs.scroll.xyz/en/sdk/guides/devnet-deployment/), [an alt-gas token testnet on Digital Ocean](https://scroll-sdk-init.docs.scroll.xyz/en/sdk/guides/digital-ocean-alt-gas-token/), or see our [production deployment](https://scroll-sdk-init.docs.scroll.xyz/en/sdk/guides/production-deployment/) page.
26+
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.
2727

2828
## Contributing
2929

30-
The SDK is currently under heavy development, so if you wish to contribute, we recommend reaching out and coordinating closely with the Scroll team.
30+
The SDK is currently under heavy development, so if you wish to contribute, we recommend reaching out and coordinating closely with the Scroll team.
31+
32+
## License
33+
34+
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.

0 commit comments

Comments
 (0)