Skip to content

Commit 2268aaa

Browse files
committed
Improve documentation
1 parent d9ed7e1 commit 2268aaa

File tree

11 files changed

+70
-65
lines changed

11 files changed

+70
-65
lines changed

README.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,42 @@ other users.
1111

1212
## Features
1313

14-
**Create an account**
15-
![Signup](docs/imgs/signup.png?raw=true)
14+
### Create an account
1615

17-
**Login**
18-
![Login](docs/imgs/login.png?raw=true)
16+
![Signup](/assets/signup.png?raw=true)
1917

20-
**Your user wallet**
21-
![Signup](docs/imgs/wallet.png?raw=true)
18+
### Login
2219

23-
**Upload file**
24-
![Upload file](docs/imgs/upload_file.png?raw=true)
20+
![Login](/assets/login.png?raw=true)
2521

26-
**My files**
27-
![My Files](docs/imgs/my_files.png?raw=true)
22+
### Your user wallet
23+
24+
![Signup](/assets/wallet.png?raw=true)
25+
26+
#### Upload file
27+
28+
![Upload file](/assets/upload_file.png?raw=true)
29+
30+
#### My files
31+
32+
![My Files](/assets/my_files.png?raw=true)
2833
You can see the list of files you uploaded and which users have access to them. By clicking
2934
on one of the little icon you can revoke the access to the users at anytime.
3035

3136
Also you can download the content of the files you uploaded.
3237

33-
**Grant access to file**
34-
![Grant access to file](docs/imgs/grant_access.png?raw=true)
38+
### Grant access to file
39+
![Grant access to file](/assets/grant_access.png?raw=true)
3540
Grant access to other users to your content without waiting for a access request.
3641

37-
**Request access to other user file**
38-
![Pending request](docs/imgs/pending_requests.png?raw=true)
42+
### Request access to other user file
43+
![Pending request](/assets/pending_requests.png?raw=true)
3944
Insert the username of other user and load the list of available items of this user.
4045
By clicking on the locker icon you will send a access request to the file owner. In case
4146
you already got access to the file it will display the download action.
4247

43-
**Request access to other user file**
44-
![Request file access](docs/imgs/request_file_access.png?raw=true)
48+
### Request access to other user file
49+
![Request file access](/assets/request_file_access.png?raw=true)
4550
On this section it will listed the pending access requests from other users to your files.
4651

4752

@@ -54,18 +59,18 @@ The first of them is what it was called stake holder account. This account
5459
is linked to every instance of the server application and it is funding the creation
5560
of new users through its own endpoints.
5661

57-
The second funding source is an Faucet smart contract which will fund
62+
The second funding source is an Faucet smart contract [0xdf81615E44b34C7015bF148De30526A4863c0DcD](https://explorer.sirius.lightstreams.io/addr/0xdf81615e44b34c7015bf148de30526a4863c0dcd) which will fund
5863
the activity of users up to 10 PHTs. This smart contract can be top up by every entity
59-
interested in the growth of the project [0xdf81615E44b34C7015bF148De30526A4863c0DcD](https://explorer.sirius.lightstreams.io/addr/0xdf81615e44b34c7015bf148de30526a4863c0dcd).
64+
interested in the growth of the project.
6065

61-
After that users can request more tokens for their accounts contacting Lightstreams Dev Team
66+
Once users exceeds the initial 10 PHTs they can request more tokens for their accounts contacting Lightstreams Dev Team
6267
either [Telegram](https://t.me/LightstreamsDevelopers) or on the [Discuss forum](https://discuss.lightstreams.network/c/dev)
6368

6469
## Getting started
6570

66-
This application is split into two independent parts:
67-
- [Server](/server/README.md) NodeJS express server connected to Lightstreams node
68-
- [UI](/app/README.md) React application connected to Dashboard server.
71+
This application is split into two separated projects. A [NodeJS server](/server/README.md)
72+
which is connected to the lightstreams smart vault, and a [user interface](/app/README.md)
73+
implemented in React and connected to NodeJS server.
6974

7075

7176
### License

app/README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,8 @@ $> cp .env.sample .env
1616

1717
## Configure server
1818
At `.env` file you can define the `SERVER_URL` which is going to act as the server
19-
side of your application.
20-
21-
### Alternative 1: Remote server
22-
Lightstreams team provides its own server: `https://demo.dashboard.lightstreams.io`
23-
24-
### Alternative 2: Local Server
25-
26-
In case you want to run a local alternative [follow this.](/server/README.md).
19+
side of your application. [Follow the instractions](/server/README.md)
20+
to run your local dashboard server.
2721

2822
## Getting started
2923

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)