34 lines
1.7 KiB
Markdown
34 lines
1.7 KiB
Markdown
<p align="center"><img src="logo.png"/></p>
|
|
|
|
# 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 | 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) |
|
|
|
|
## Special thanks to:
|
|
* The [Neurodiversity Matrix room](https://matrix.to/#/#neurodiversity:artemislena.eu), which gave me feedback on UX and the logo.
|
|
* [Reactiflux](https://reactiflux.com), which helped me every step of the way with technical issues.
|
|
* **You**. |