aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/docs/README.md b/docs/README.md
index 3d07efe..6dea371 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,2 +1,11 @@
-# Introduction
+# Luxcena-Neo
+Dependencies [![dependencies Status](https://david-dm.org/jakobst1n/luxcena-neo/dev/status.svg)](https://david-dm.org/jakobst1n/luxcena-neo)[![devDependencies Status](https://david-dm.org/jakobst1n/luxcena-neo/dev/dev-status.svg)](https://david-dm.org/jakobst1n/luxcena-neo?type=dev)
+Branch (dev) [![dependencies Status](https://david-dm.org/jakobst1n/luxcena-neo/dev/status.svg)](https://david-dm.org/jakobst1n/luxcena-neo/dev)[![devDependencies Status](https://david-dm.org/jakobst1n/luxcena-neo/dev/dev-status.svg)](https://david-dm.org/jakobst1n/luxcena-neo/dev?type=dev)
+
+
+## Install
+Please refer to this guide for installing: [Install Luxcena-neo](Usage/Install.md).
+## Issues
+*There might still be a bit hard for someone not having spent hours looking at the source to use this software.
+But i assure you that it will be really easy to use shortly*