mirror of
https://github.com/ArthurDanjou/artdanj-shortener.git
synced 2026-01-14 15:54:08 +01:00
Update README.md
This commit is contained in:
41
README.md
Normal file
41
README.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Linky 🔗
|
||||
<p align="center">
|
||||
URL Shortener for Developers 💻
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://www.npmjs.com/package/@linkyjs/core" target="__blank"><img src="https://img.shields.io/npm/v/@linkyjs/core?color=2B90B6&label=" alt="NPM version"></a>
|
||||
<a href="https://www.npmjs.com/package/@linkyjs/core" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@linkyjs/core?color=349dbe&label="></a>
|
||||
<a href="https://linkyjs.dev/" target="__blank"><img src="https://img.shields.io/static/v1?label=&message=docs&color=45b8cd" alt="Docs"></a>
|
||||
<br>
|
||||
<a href="https://github.com/linkyjs/core" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/linkyjs/core?style=social"></a>
|
||||
</p>
|
||||
|
||||
## Features ✨
|
||||
|
||||
- ⛓ Create an unique short code to redirect to a very long link.
|
||||
- 🎭 Authentication with AdonisJs to secure the entries.
|
||||
- 📊 Visit Counts to have a few stats
|
||||
- 🎇 Automated Cli to save time
|
||||
|
||||
## Tech used ⚙
|
||||
|
||||
- AdonisJs (HTTP Server & Authentication)
|
||||
- TypeScript (Type Javascript)
|
||||
- MariaDB (Database)
|
||||
- Docker (Deployment)
|
||||
|
||||
## Informations ❕
|
||||
|
||||
📚 Documentations : **[English](https://linkyjs.dev)** | **[Français](https://fr.linkyjs.dev)**
|
||||
|
||||
🎤 Discord : Join my [Discord's server](https://discord.gg/zxHTbSs)
|
||||
|
||||
## Author 👤
|
||||
➡ Arthur Danjou : Developer
|
||||
- Twitter : [@ArthurDanj](https://twitter.com/ArthurDanj)
|
||||
- GitHub : [@ArthurDanjou](https://github.com/ArthurDanjou)
|
||||
|
||||
## License 📑
|
||||
Copyright © 2021 - [@ArthurDanj](https://arthurdanjou.fr) \
|
||||
This project is [MIT](https://github.com/linkyjs/core/blob/master/LICENSE) Licensed.
|
||||
Reference in New Issue
Block a user