Wrote the rest of readme

This commit is contained in:
mikwee 2021-11-23 14:35:29 +02:00
parent 7916580d2a
commit 17f2024129
11 changed files with 19 additions and 3 deletions

View File

@ -1,13 +1,29 @@
# LinkRoots
<p align="center"><img src="src\logo.png"/></p>
LinkRoots is a libre, lightweight, self-hosted alternative to Linktree.
## How to use it
1. Clone the repository.
2. Replace `background.png` with any background image of your choice.
3. Edit `roots.json` to modify the page. The example should be enough to help you understand the format, but feel free to ask me questions if you still don't get it!
4. Host it!
## Button types
| Type | |
|---|---|
| | |
| Type | Description | Example |
| --- | --- | --- |
| `basic` | A basic button, not associated with any particular site. | ![Basic Button](buttonImages\basic.png) |
| `facebook` | A button for Facebook pages. | ![Facebook Button](buttonImages\facebook.png) |
| `instagram` | A button for Instagram pages. | ![Instagram Button](buttonImages\instagram.png) |
| `twitter` | A button for Twitter pages. | ![Twitter Button](buttonImages\twitter.png) |
| `github` | A button for GitHub pages. | ![GitHub Button](buttonImages\github.png) |
| `youtube` | A button for YouTube pages. | ![YouTube Button](buttonImages\youtube.png) |
| `linkedin` | A button for LinkedIn pages. | ![LinkedIn Button](buttonImages\linkedin.png) |
| `pinterest` | A button for Pinterest pages. | ![Pinterest Button](buttonImages\pinterest.png) |
| `tumblr` | A button for Tumblr pages. | ![Reddit Button](buttonImages\tumblr.png) |
| `reddit` | A button for Reddit pages. | ![Reddit Button](buttonImages\reddit.png) |

BIN
buttonImages/basic.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.7 KiB

BIN
buttonImages/facebook.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

BIN
buttonImages/github.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

BIN
buttonImages/instagram.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

BIN
buttonImages/linkedin.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

BIN
buttonImages/pinterest.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.6 KiB

BIN
buttonImages/reddit.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.6 KiB

BIN
buttonImages/tumblr.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.7 KiB

BIN
buttonImages/twitter.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

BIN
buttonImages/youtube.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.4 KiB