From 1df1ae23ae1a16362522dff8bc6b824a7ee0f7d6 Mon Sep 17 00:00:00 2001
From: Arthur DANJOU <arthurdanjou@outlook.fr>
Date: Wed, 16 Dec 2020 16:09:21 +0100
Subject: [PATCH] add Readme.md

---
 .idea/vcs.xml      |  6 ++++++
 Dockerfile         | 21 ---------------------
 README.md          | 30 +++++++++++++++++++++++++++++-
 docker-compose.yml | 21 ---------------------
 4 files changed, 35 insertions(+), 43 deletions(-)
 create mode 100644 .idea/vcs.xml
 delete mode 100644 Dockerfile
 delete mode 100644 docker-compose.yml

diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 0000000..94a25f7
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
deleted file mode 100644
index 13cd9e7..0000000
--- a/Dockerfile
+++ /dev/null
@@ -1,21 +0,0 @@
-FROM node:lts-alpine
-
-RUN mkdir -p /home/node/app/node_modules
-
-WORKDIR /home/node/app
-
-COPY package.json yarn.* ./
-
-RUN apk add --no-cache git
-
-COPY . /home/node/app/
-
-RUN chown -R node:node /home/node
-
-RUN yarn
-
-USER node
-
-EXPOSE 3333
-
-ENTRYPOINT ["node","ace","serve","--watch"]
diff --git a/README.md b/README.md
index c3dd3cd..c435b53 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,29 @@
-# artapi
+# ArtApi 🧠
+
+ArtAPi is my personnal api connected to my instances
+
+## Features ✨
+
+- Likes system
+- Location sharing
+- Mail System
+- Notification system with subscribers
+
+## Tech used ⚙
+
+- AdonisJs v5 (BackEnd)
+- Redis (Caching)
+- MariaDb (Storage)
+
+## Usage 📚
+
+- *soon*
+
+## 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/artapi/blob/master/License) Licensed.
diff --git a/docker-compose.yml b/docker-compose.yml
deleted file mode 100644
index c4a727f..0000000
--- a/docker-compose.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-version: "3"
-services:
-  mariadb:
-    image: mariadb
-      restart: always
-      environment:
-        MYSQL_ROOT_PASSWORD: password
-        MYSQL_USER: root
-        MYSQL_PASSWORD: password
-        MYSQL_DATABASE: artapi
-  adonisjs:
-    build:
-      context: .
-      dockerfile: Dockerfile
-      volumes:
-        - .:/home/node/app
-        - /home/node/app/node_modules
-      ports:
-        - 80:3333
-      depends_on:
-        - mariadb