diff --git a/README.md b/README.md index fec38c3..055d948 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,28 @@ ![](https://img.shields.io/badge/npm-%3E%3D6.0.0-orange.svg?style=flat-square) ![](https://img.shields.io/badge/Node.js-%3E%3D10.0.0-orange.svg?style=flat-square) -> An app which helps users to setup their Bee node and do actions like cash out cheques, upload and download files or manage your postage stamps. +> An app which helps users to setup their Bee node and do actions like cash out cheques, upload and download files or +> manage your postage stamps. -**Warning: This project is in alpha state. There might (and most probably will) be changes in the future to its API and working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.** +**Warning: This project is in alpha state. There might (and most probably will) be changes in the future to its API and +working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.** -This project is intended to be used with **Bee version 1.1.0**. Using it with older or newer Bee versions is not recommended and may not work. Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the [releases tab](https://github.com/ethersphere/bee-dashboard/releases). +This project is intended to be used with the latest released version of Bee. Using it with older Bee versions is not +recommended and may not work. Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and by +keeping an eye on the [releases tab](https://github.com/ethersphere/bee-dashboard/releases). -![Status page](/ui_samples/status.png) - -| Node Setup | Browse & Upload Files | Accounting | Peers | Settings | -|-------|---------|-------|----------|------| -| ![Setup](/ui_samples/node_setup.png) | ![Files](/ui_samples/file_upload.png) | ![Accounting](/ui_samples/accounting.png) | ![Peers](/ui_samples/peers.png) | ![Settings](/ui_samples/settings.png) | +![Status page](/ui_samples/info.png) +| Node Setup | Upload Files | Download Content | Accounting | Postage Stamps | +| ------------------------------------ | -------------------------------------- | ------------------------------------------ | ----------------------------------------- | ---------------------------------------- | +| ![Setup](/ui_samples/node_setup.png) | ![Upload](/ui_samples/file_upload.png) | ![Download](/ui_samples/file_download.png) | ![Accounting](/ui_samples/accounting.png) | ![Peers](/ui_samples/postage_stamps.png) | ## Table of Contents - [Install](#install) - [Usage](#usage) - - [Terminal](#terminal) - - [Docker](#docker) + - [Terminal](#terminal) + - [Docker](#docker) - [Contribute](#contribute) - [Development](#development) - [Maintainers](#maintainers) @@ -40,11 +43,15 @@ npm install -g @ethersphere/bee-dashboard ## Usage -:warning: To successfully connect to the Bee node, you will need to enable the Debug API and CORS. You can do so by setting `cors-allowed-origins: ['*']` and `debug-api-enable: true` in the Bee config file and then restart the Bee node. To see where the config file is, consult the [official Bee documentation](https://docs.ethswarm.org/docs/working-with-bee/configuration#configuring-bee-installed-using-a-package-manager) +:warning: To successfully connect to the Bee node, you will need to enable the Debug API and CORS. You can do so by +setting `cors-allowed-origins: ['*']` and `debug-api-enable: true` in the Bee config file and then restart the Bee node. +To see where the config file is, consult the +[official Bee documentation](https://docs.ethswarm.org/docs/working-with-bee/configuration#configuring-bee-installed-using-a-package-manager) ### Terminal To start use: + ```sh bee-dashboard ``` @@ -82,7 +89,8 @@ There are some ways you can make this module better: - Consult our [open issues](https://github.com/ethersphere/bee-dashboard/issues) and take on one of them - Help our tests reach 100% coverage! -- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or want to give feedback +- Join us in our [Discord chat](https://discord.gg/wdghaQsGq5) in the #develop-on-swarm channel if you have questions or + want to give feedback ## Maintainers diff --git a/ui_samples/accounting.png b/ui_samples/accounting.png index 752b47f..5d2e169 100644 Binary files a/ui_samples/accounting.png and b/ui_samples/accounting.png differ diff --git a/ui_samples/file_download.png b/ui_samples/file_download.png new file mode 100644 index 0000000..072e67e Binary files /dev/null and b/ui_samples/file_download.png differ diff --git a/ui_samples/file_upload.png b/ui_samples/file_upload.png index c924fdb..6a97753 100644 Binary files a/ui_samples/file_upload.png and b/ui_samples/file_upload.png differ diff --git a/ui_samples/info.png b/ui_samples/info.png new file mode 100644 index 0000000..dd28076 Binary files /dev/null and b/ui_samples/info.png differ diff --git a/ui_samples/node_setup.png b/ui_samples/node_setup.png index 0eaf11d..5eca1a6 100644 Binary files a/ui_samples/node_setup.png and b/ui_samples/node_setup.png differ diff --git a/ui_samples/peers.png b/ui_samples/peers.png deleted file mode 100644 index bfedfe0..0000000 Binary files a/ui_samples/peers.png and /dev/null differ diff --git a/ui_samples/postage_stamps.png b/ui_samples/postage_stamps.png new file mode 100644 index 0000000..a4e49e7 Binary files /dev/null and b/ui_samples/postage_stamps.png differ diff --git a/ui_samples/settings.png b/ui_samples/settings.png deleted file mode 100644 index 374e34f..0000000 Binary files a/ui_samples/settings.png and /dev/null differ diff --git a/ui_samples/status.png b/ui_samples/status.png deleted file mode 100644 index 5a58515..0000000 Binary files a/ui_samples/status.png and /dev/null differ