From bcbfa306e115831aaa4c66cbb0284fdd0475afbd Mon Sep 17 00:00:00 2001 From: Shawaiz Khan Date: Fri, 27 Sep 2024 17:21:42 +0100 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8a0425d..7128a0d 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # 9c-board -A web application to provide useful tools. You can access it in https://9c-board.nine-chronicles.dev/. +A web application to provide useful tools. You can access it at https://9c-board.nine-chronicles.dev/. -## Devlopment +## Development ### Configure Environment -- Create `.env` file to project root directory. +- Create a `.env` file in the project's root directory. ``` # Set network config map e.g., @@ -26,13 +26,13 @@ yarn dev ### Planets & Networks -NineChronicle's blockchain network is divided into planets, which can be found below. +NineChronicles' blockchain network is divided into planets, which can be found below. -- main network: https://planets.nine-chronicles.com/planets -- internal network: https://planets-internal.nine-chronicles.com/planets +- Main network: https://planets.nine-chronicles.com/planets +- Internal network: https://planets-internal.nine-chronicles.com/planets -As you can see above, NineChronicle's planets are divided into main and internal networks for deployment purposes. -Therefore, each of the features provided here must be used separately for each planet and network. +As shown above, NineChronicles' planets are divided into main and internal networks for deployment purposes. +Each feature provided here must be used separately for each planet and network. This is a common way to determine what goes into the '[NETWORK]' location in the URL of a feature, which we'll discuss below. @@ -41,20 +41,20 @@ This is a common way to determine what goes into the '[NETWORK]' location in the | odin | odin | odin-internal | | heimdall | heimdall | heimdall-internal | -And since this information is tied to the `NETWORK_CONF_MAP` value and `MIMIR_GRAPHQL_URL_MAP` value you define in your `.env` file, you can change it. +Since this information is tied to the `NETWORK_CONF_MAP` and `MIMIR_GRAPHQL_URL_MAP` values defined in your `.env` file, you can change it as needed. -### Show tablesheet in web +### Show Tablesheet in Web `https://9c-board.nine-chronicles.dev/[NETWORK]/tablesheet/[TABLESHEET_NAME]` -For instance, you can see current `StakeRegularRewardSheet` of `odin` network in `https://9c-board.nine-chronicles.dev/odin/tablesheet/StakeRegularRewardSheet`. +For instance, you can see the current `StakeRegularRewardSheet` of the `odin` network at `https://9c-board.nine-chronicles.dev/odin/tablesheet/StakeRegularRewardSheet`. image -### Show avatar in web +### Show Avatar in Web `https://9c-board.nine-chronicles.dev/[NETWORK]/avatar/[AVATAR_ADDRESS]?` -You can see some avatar state in web. +You can view some avatar states on the web. image