(feat) update main readme

This commit is contained in:
Michael Feng
2023-08-03 12:38:03 -07:00
parent c6412b1d6d
commit b972efbb06
3 changed files with 29 additions and 11 deletions

View File

@@ -21,7 +21,7 @@ show_pages(
st.write("Watch this video to understand how the dashboard works! 🦅")
c1, c2, c3 = st.columns([1, 6, 1])
with c2:
st.video("https://youtu.be/l6PWbN2pDK8")
st.write("If you want to contribute, post your idea in #dev-channel of [hummingbot discord](https://discord.gg/CjxZtkrH)")
st.write("---")
with c2:
st.video("https://youtu.be/2q9HSyIPuf4")
st.write("Please give us feedback in the **#dashboard** channel of the [Hummingbot Discord](https://discord.gg/hummingbot)! 🙏")

View File

@@ -1 +1,19 @@
Deploy and manage Hummingbot instances
### Description
This page helps you deploy and manage Hummingbot instances:
- Starting and stopping Hummingbot Broker
- Creating, starting and stopping bot instances
- Managing strategy and script files that instances run
- Fetching status of running instances
### Maintainers
This page is maintained by Hummingbot Foundation as a template other pages:
* [cardosfede](https://github.com/cardosfede)
* [fengtality](https://github.com/fengtality)
### Wiki
See the [wiki](https://github.com/hummingbot/dashboard/wiki/%F0%9F%90%99-Bot-Orchestration) for more information.

View File

@@ -130,22 +130,22 @@ with orchestrate:
with mui.Paper(elevation=3, style={"padding": "2rem"}, spacing=[2, 2], container=True):
with mui.Grid(container=True, spacing=4):
with mui.Grid(item=True, xs=12):
mui.Typography("🚀 Set up a new bot", variant="h3")
mui.Typography("🚀 Create Bot", variant="h4")
with mui.Grid(item=True, xs=8):
mui.TextField(label="Bot Name", variant="outlined", onChange=lazy(sync("new_bot_name")),
sx={"width": "100%"})
with mui.Grid(item=True, xs=4):
with mui.Button(onClick=launch_new_bot):
mui.icon.AddCircleOutline()
mui.Typography("Create new bot!")
mui.Typography("Create")
with mui.Grid(item=True, xs=6):
with mui.Paper(elevation=3, style={"padding": "2rem"}, spacing=[2, 2], container=True):
with mui.Grid(container=True, spacing=4):
with mui.Grid(item=True, xs=12):
mui.Typography("🐙 Hummingbot Broker", variant="h3")
mui.Typography("🐙 Manage Broker", variant="h4")
with mui.Grid(item=True, xs=8):
mui.Typography("To control and monitor your bots you need to launch the Hummingbot Broker."
"This component will send the commands to the running bots.")
mui.Typography("To control and monitor your bots you need to launch Hummingbot Broker."
"This component enables two-way communication with bots.")
with mui.Grid(item=True, xs=4):
button_text = "Stop Broker" if st.session_state.is_broker_running else "Start Broker"
color = "error" if st.session_state.is_broker_running else "success"
@@ -156,7 +156,7 @@ with orchestrate:
with elements("active_instances_board"):
with mui.Paper(elevation=3, style={"padding": "2rem"}, spacing=[2, 2], container=True):
mui.Typography("🦅 Active Instances", variant="h3")
mui.Typography("🦅 Active Bots", variant="h4")
if st.session_state.is_broker_running:
quantity_of_active_bots = len(st.session_state.active_bots)
if quantity_of_active_bots > 0:
@@ -182,7 +182,7 @@ with orchestrate:
st.session_state.exited_bots[exited_instance] = ExitedBotCard(exited_instances_board, x, y,
CARD_WIDTH, 1)
with mui.Paper(elevation=3, style={"padding": "2rem"}, spacing=[2, 2], container=True):
mui.Typography("💤 Stopped Instances", variant="h3")
mui.Typography("💤 Stopped Bots", variant="h4")
with exited_instances_board():
for bot, card in st.session_state.exited_bots.items():
card(bot)