Filled in readme

This commit is contained in:
Nicolai Ort 2021-08-16 18:31:21 +02:00
parent 08520ac616
commit 1ed7c79883
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F
2 changed files with 27 additions and 2 deletions

View File

@ -1,3 +1,28 @@
# LinkyLinky Extension
<p align="center">
<img height="150" src="./static/icon_128.png">
<h1 align="center">LinkyLinky Web</h1>
<h3 align="center">A simple, privacy focused urls shortner's dashboard</h3>
</p>
> The companion extension for LinkyLinky
<!-- ## 👀 Preview
TODO: -->
## Dev Setup 🛠
> Runs on port 3000
#### Yarn
```bash
yarn
yarn dev --open
```
#### NPM
```bash
npm i
npm run dev --open
```
## Credits
* ClipboardJS by Zeno Rocha licensed under MIT - Website: https://clipboardjs.com/ - Repo: https://github.com/zenorocha/clipboard.js
* TailwindCSS by TailwindLabs licensed under MIT - Website: https://tailwindcss.com - Repo: https://github.com/tailwindlabs/tailwindcss
* LinkyLinky Server: https://git.odit.services/kauft.es/linkylinky

BIN
static/icon_128.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.3 KiB