Skip to content

Commit d4c2bf2

Browse files
committed
update readme
1 parent e107853 commit d4c2bf2

File tree

4 files changed

+420
-363
lines changed

4 files changed

+420
-363
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022-2024 Scroll
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 44 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
1-
scroll-sdk-cli
2-
=================
1+
# Scroll SDK CLI
2+
[![Twitter Follow](https://img.shields.io/twitter/follow/Scroll_ZKP?style=social)](https://twitter.com/Scroll_ZKP)
3+
[![Discord](https://img.shields.io/discord/984015101017346058?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/scroll)
34

4-
A tool for managing and testing Scroll SDK deployments
5+
## Introduction
6+
7+
A tool for configuring, managing, and testing [Scroll SDK](https://docs.scroll.io/en/sdk/) deployments.
8+
9+
### Other Scroll SDK Repos
10+
11+
- [Scroll SDK](https://www.github.com/scroll-tech/scroll-sdk)
12+
- [Scroll Proving SDK](https://www.github.com/scroll-tech/scroll-proving-sdk)
513

614

715
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
@@ -29,34 +37,39 @@ USAGE
2937
<!-- usagestop -->
3038
# Commands
3139
<!-- commands -->
32-
* [`scrollsdk help [COMMAND]`](#scrollsdk-help-command)
33-
* [`scrollsdk helper activity`](#scrollsdk-helper-activity)
34-
* [`scrollsdk helper clear-accounts`](#scrollsdk-helper-clear-accounts)
35-
* [`scrollsdk helper derive-enode NODEKEY`](#scrollsdk-helper-derive-enode-nodekey)
36-
* [`scrollsdk helper fund-accounts`](#scrollsdk-helper-fund-accounts)
37-
* [`scrollsdk helper set-scalars`](#scrollsdk-helper-set-scalars)
38-
* [`scrollsdk plugins`](#scrollsdk-plugins)
39-
* [`scrollsdk plugins add PLUGIN`](#scrollsdk-plugins-add-plugin)
40-
* [`scrollsdk plugins:inspect PLUGIN...`](#scrollsdk-pluginsinspect-plugin)
41-
* [`scrollsdk plugins install PLUGIN`](#scrollsdk-plugins-install-plugin)
42-
* [`scrollsdk plugins link PATH`](#scrollsdk-plugins-link-path)
43-
* [`scrollsdk plugins remove [PLUGIN]`](#scrollsdk-plugins-remove-plugin)
44-
* [`scrollsdk plugins reset`](#scrollsdk-plugins-reset)
45-
* [`scrollsdk plugins uninstall [PLUGIN]`](#scrollsdk-plugins-uninstall-plugin)
46-
* [`scrollsdk plugins unlink [PLUGIN]`](#scrollsdk-plugins-unlink-plugin)
47-
* [`scrollsdk plugins update`](#scrollsdk-plugins-update)
48-
* [`scrollsdk setup configs`](#scrollsdk-setup-configs)
49-
* [`scrollsdk setup db-init`](#scrollsdk-setup-db-init)
50-
* [`scrollsdk setup domains [FILE]`](#scrollsdk-setup-domains-file)
51-
* [`scrollsdk setup gas-token`](#scrollsdk-setup-gas-token)
52-
* [`scrollsdk setup gen-keystore`](#scrollsdk-setup-gen-keystore)
53-
* [`scrollsdk setup prep-charts`](#scrollsdk-setup-prep-charts)
54-
* [`scrollsdk setup push-secrets`](#scrollsdk-setup-push-secrets)
55-
* [`scrollsdk setup tls`](#scrollsdk-setup-tls)
56-
* [`scrollsdk test contracts`](#scrollsdk-test-contracts)
57-
* [`scrollsdk test dependencies`](#scrollsdk-test-dependencies)
58-
* [`scrollsdk test e2e`](#scrollsdk-test-e2e)
59-
* [`scrollsdk test ingress`](#scrollsdk-test-ingress)
40+
- [Scroll SDK CLI](#scroll-sdk-cli)
41+
- [Introduction](#introduction)
42+
- [Other Scroll SDK Repos](#other-scroll-sdk-repos)
43+
- [Usage](#usage)
44+
- [Commands](#commands)
45+
- [`scrollsdk help [COMMAND]`](#scrollsdk-help-command)
46+
- [`scrollsdk helper activity`](#scrollsdk-helper-activity)
47+
- [`scrollsdk helper clear-accounts`](#scrollsdk-helper-clear-accounts)
48+
- [`scrollsdk helper derive-enode NODEKEY`](#scrollsdk-helper-derive-enode-nodekey)
49+
- [`scrollsdk helper fund-accounts`](#scrollsdk-helper-fund-accounts)
50+
- [`scrollsdk helper set-scalars`](#scrollsdk-helper-set-scalars)
51+
- [`scrollsdk plugins`](#scrollsdk-plugins)
52+
- [`scrollsdk plugins add PLUGIN`](#scrollsdk-plugins-add-plugin)
53+
- [`scrollsdk plugins:inspect PLUGIN...`](#scrollsdk-pluginsinspect-plugin)
54+
- [`scrollsdk plugins install PLUGIN`](#scrollsdk-plugins-install-plugin)
55+
- [`scrollsdk plugins link PATH`](#scrollsdk-plugins-link-path)
56+
- [`scrollsdk plugins remove [PLUGIN]`](#scrollsdk-plugins-remove-plugin)
57+
- [`scrollsdk plugins reset`](#scrollsdk-plugins-reset)
58+
- [`scrollsdk plugins uninstall [PLUGIN]`](#scrollsdk-plugins-uninstall-plugin)
59+
- [`scrollsdk plugins unlink [PLUGIN]`](#scrollsdk-plugins-unlink-plugin)
60+
- [`scrollsdk plugins update`](#scrollsdk-plugins-update)
61+
- [`scrollsdk setup configs`](#scrollsdk-setup-configs)
62+
- [`scrollsdk setup db-init`](#scrollsdk-setup-db-init)
63+
- [`scrollsdk setup domains [FILE]`](#scrollsdk-setup-domains-file)
64+
- [`scrollsdk setup gas-token`](#scrollsdk-setup-gas-token)
65+
- [`scrollsdk setup gen-keystore`](#scrollsdk-setup-gen-keystore)
66+
- [`scrollsdk setup prep-charts`](#scrollsdk-setup-prep-charts)
67+
- [`scrollsdk setup push-secrets`](#scrollsdk-setup-push-secrets)
68+
- [`scrollsdk setup tls`](#scrollsdk-setup-tls)
69+
- [`scrollsdk test contracts`](#scrollsdk-test-contracts)
70+
- [`scrollsdk test dependencies`](#scrollsdk-test-dependencies)
71+
- [`scrollsdk test e2e`](#scrollsdk-test-e2e)
72+
- [`scrollsdk test ingress`](#scrollsdk-test-ingress)
6073

6174
## `scrollsdk help [COMMAND]`
6275

0 commit comments

Comments
 (0)