From e76351ddc18295ecbdbe85fac14e98e4013ba9d6 Mon Sep 17 00:00:00 2001
From: Sheldan <5037282+Sheldan@users.noreply.github.com>
Date: Wed, 10 Jun 2020 13:50:35 +0200
Subject: [PATCH] added first version of readme

---
 LICENSE   |  2 +-
 README.md | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
index d8a656e84..44aa8edd5 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Sheldan
+Copyright (c) 2020 Sheldan
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..17bf0681e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# Abstracto
+
+![Build](https://github.com/Sheldan/abstracto/workflows/Execute%20build%20and%20Sonar/badge.svg)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=abstracto-abstracto&metric=coverage)](https://sonarcloud.io/dashboard?id=abstracto-abstracto)
+[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/dashboard?id=abstracto-abstracto)
+[![GitHub license](https://img.shields.io/github/license/Sheldan/abstracto)](https://github.com/Sheldan/abstracto/blob/master/LICENSE)
+
+
+Abastracto represents a framework to be used as a basis for a Discord bot. It uses [JDA](https://github.com/DV8FromTheWorld/JDA/) as an API wrapper underneath
+and provides an extensive tool set to create new commands and a wide range of commands out of the box.
+
+This repository does not provide the full functionality in order to start a discord bot, because it requires a Main class. 
+An example implementation of this bot can be seen [here](https://github.com/Sheldan/Crimson). This repository contains the required configuration in order to run a bot and example customizations.
+
+
+## Technologies
+* [JDA](https://github.com/DV8FromTheWorld/JDA/) The Discord API Wrapper in the version 4.1.1_155
+* [Spring boot](https://github.com/spring-projects/spring-boot) is used as a framework to create standalone application in Java with Java EE methods. (including Dependency injection and more)
+* [Hibernate](https://github.com/hibernate/hibernate-orm) is used as a reference implementation of JPA.
+* [Freemarker](https://github.com/apache/freemarker) is used as a templating engine. This is used to provide internationalization for user facing text and enable dynamic embed configuration.
+* [Ehcache](https://github.com/ehcache/ehcache3) is used as a caching implementation for the database and other caches.
+* [Lombok](https://github.com/rzwitserloot/lombok) is used as a framework in order to speed up creation of container classes and builders.
+* [Quartz](https://github.com/quartz-scheduler/quartz) is used as a scheduling framework in order to provide functionalities which either require a delayed or cronjob behaviour.
+
+## Documentation
+A detailed documentation of the pure form of Abstracto including the terminology and commands in HTML form is available [here](https://sheldan.github.io/abstracto-docs/). The PDF is available [here](https://sheldan.github.io/abstracto-docs/documentation.pdf)
+If you want to view the documentation to an earlier released version you need to append the desired version to the URL. The current version will be available aforementioned URL, but it is not right now, because Abstracto has not been released yet.
+
+## Customization documentation 
+TBD when Abstracto is released, as the current version is still being adapted, because of findings from the example customization in Crimson.
+
+## Issues
+If you find any issue, feel free to create a GitHub issue.
+
+## License
+This project is licensed under the MIT license.
\ No newline at end of file