diff --git a/README.md b/README.md index 36faf8d..1f295a9 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,29 @@ # LinkRoots +

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) | \ No newline at end of file diff --git a/buttonImages/basic.png b/buttonImages/basic.png new file mode 100644 index 0000000..e1d49db Binary files /dev/null and b/buttonImages/basic.png differ diff --git a/buttonImages/facebook.png b/buttonImages/facebook.png new file mode 100644 index 0000000..0f6634d Binary files /dev/null and b/buttonImages/facebook.png differ diff --git a/buttonImages/github.png b/buttonImages/github.png new file mode 100644 index 0000000..c2dd612 Binary files /dev/null and b/buttonImages/github.png differ diff --git a/buttonImages/instagram.png b/buttonImages/instagram.png new file mode 100644 index 0000000..a51d964 Binary files /dev/null and b/buttonImages/instagram.png differ diff --git a/buttonImages/linkedin.png b/buttonImages/linkedin.png new file mode 100644 index 0000000..fefd711 Binary files /dev/null and b/buttonImages/linkedin.png differ diff --git a/buttonImages/pinterest.png b/buttonImages/pinterest.png new file mode 100644 index 0000000..b428454 Binary files /dev/null and b/buttonImages/pinterest.png differ diff --git a/buttonImages/reddit.png b/buttonImages/reddit.png new file mode 100644 index 0000000..5082df4 Binary files /dev/null and b/buttonImages/reddit.png differ diff --git a/buttonImages/tumblr.png b/buttonImages/tumblr.png new file mode 100644 index 0000000..7adf91b Binary files /dev/null and b/buttonImages/tumblr.png differ diff --git a/buttonImages/twitter.png b/buttonImages/twitter.png new file mode 100644 index 0000000..e1820df Binary files /dev/null and b/buttonImages/twitter.png differ diff --git a/buttonImages/youtube.png b/buttonImages/youtube.png new file mode 100644 index 0000000..0d9be80 Binary files /dev/null and b/buttonImages/youtube.png differ