feat: updated readme to new bee version and UI examples with new design (#230)
@@ -6,25 +6,28 @@
|
|||||||

|

|
||||||

|

|
||||||
|
|
||||||
> 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).
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
| Node Setup | Browse & Upload Files | Accounting | Peers | Settings |
|
|
||||||
|-------|---------|-------|----------|------|
|
|
||||||
|  |  |  |  |  |
|
|
||||||
|
|
||||||
|
| Node Setup | Upload Files | Download Content | Accounting | Postage Stamps |
|
||||||
|
| ------------------------------------ | -------------------------------------- | ------------------------------------------ | ----------------------------------------- | ---------------------------------------- |
|
||||||
|
|  |  |  |  |  |
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
- [Install](#install)
|
- [Install](#install)
|
||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Terminal](#terminal)
|
- [Terminal](#terminal)
|
||||||
- [Docker](#docker)
|
- [Docker](#docker)
|
||||||
- [Contribute](#contribute)
|
- [Contribute](#contribute)
|
||||||
- [Development](#development)
|
- [Development](#development)
|
||||||
- [Maintainers](#maintainers)
|
- [Maintainers](#maintainers)
|
||||||
@@ -40,11 +43,15 @@ npm install -g @ethersphere/bee-dashboard
|
|||||||
|
|
||||||
## Usage
|
## 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
|
### Terminal
|
||||||
|
|
||||||
To start use:
|
To start use:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
bee-dashboard
|
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
|
- Consult our [open issues](https://github.com/ethersphere/bee-dashboard/issues) and take on one of them
|
||||||
- Help our tests reach 100% coverage!
|
- 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
|
## Maintainers
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 115 KiB |
|
After Width: | Height: | Size: 108 KiB |
|
Before Width: | Height: | Size: 106 KiB After Width: | Height: | Size: 135 KiB |
|
Before Width: | Height: | Size: 58 KiB |
|
After Width: | Height: | Size: 67 KiB |
|
Before Width: | Height: | Size: 47 KiB |
|
Before Width: | Height: | Size: 102 KiB |