From b4c579bc464b8bc9f20fb4e345ecf0f71717517b Mon Sep 17 00:00:00 2001
From: Arthur Danjou <arthurdanjou@outlook.fr>
Date: Fri, 11 Jun 2021 11:01:22 +0200
Subject: [PATCH] Update README.md

---
 README.md    | 41 +++++++++++++++++++++++++++++++++++++++++
 ReadMe.md    | 41 -----------------------------------------
 package.json | 15 +++++++++++++--
 3 files changed, 54 insertions(+), 43 deletions(-)
 create mode 100644 README.md
 delete mode 100644 ReadMe.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..05a35a3
--- /dev/null
+++ b/README.md
@@ -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.
diff --git a/ReadMe.md b/ReadMe.md
deleted file mode 100644
index 00e1708..0000000
--- a/ReadMe.md
+++ /dev/null
@@ -1,41 +0,0 @@
-# ArtClick 🔗
-This is my personal URL Shortener.
-
-Hosted version: [**artclick.fr**](https://artclick.fr) *(Soon)*
-
-## Features ✨
-
-- Create an unique short code to redirect to a very long link.
-- Caching with Redis to do not duplicate visit counts and to save resources.
-- Authentication with AdonisJs to secure the entries.
-- Visit Counts to have a few stats
-
-## Tech used ⚙
-
-- AdonisJs (HTTP Server & Authentication)
-- Redis (Caching)
-- MariaDB (Database)
-- Kubernetes + Docker (Deployment) *(Soon)*
-
-## Usage 📚
-
-- Authentication
-  - https://artclick.fr/auth/login ➡ Login
-  - https://artclick.fr/auth/logout ➡ Logout
-- Options
-  - https://artclick.fr/options/create ➡ Create a new shortened link
-  - https://artclick.fr/options/update ➡ Update a shortened link
-  - https://artclick.fr/options/delete ➡ Delete a shortened link
-- Links
-  - https://artclick.fr/ ➡ Get all links with informations
-  - https://artclick.fr/(code) ➡ Redirect to the shortened link's target
-  - https://artclick.fr/(code)/count ➡ Get the shortened link's visit count
-
-## Author 👤
-➡ Arthur Danjou : Developer
-- Twitter : [@ArthurDanj](https://twitter.com/ArthurDanj)
-- GitHub : [@ArthurDanjou](https://github.com/ArthurDanjou)
-
-## License 📑
-Copyright © 2020 - [@ArthurDanj](https://arthurdanjou.fr) \
-This project is [MIT](https://github.com/ArthurDanjou/artclick/blob/master/LICENSE) Licensed.
diff --git a/package.json b/package.json
index 7f31f60..2f7b74b 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,18 @@
 {
-  "name": "artclick",
+  "name": "@linkyjs/core",
   "version": "1.0.0",
-  "private": true,
+  "description": "URL Shortener for Developers 💻",
+  "main": "start/kernel.ts",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/linkyjs/core.git"
+  },
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/linkyjs/core/issues"
+  },
+  "homepage": "https://github.com/linkyjs/core#readme",
   "scripts": {
     "build": "node ace build --production",
     "start": "node server.js",