Update README.md

README.md

@@ -1,5 +1,5 @@
 # 🚀 Getting started with PomeloNote
-
+### **THIS REPOSITORY HAS DEPENDENCIES WITH SECURITY VULNERABILITIES. YOU MIGHT WANT TO UPDATE PACKAGES BEFORE USE.**
 ## Setup
 - run `npm i`
 - get the .env file and save it to the root directory of the project

docs/_config.yml

@@ -0,0 +1,3 @@
+remote_theme: pages-themes/leap-day@v0.2.0
+plugins:
+- jekyll-remote-theme

docs/_data/devs.csv

@@ -0,0 +1,4 @@
+name,github,image
+Jonas Weissengruber,j-weissen,jowei
+Stefan Prechtler,s-prechtl,stef
+David Hain,d-hain,dave

docs/index.md

@@ -0,0 +1,31 @@
+# Pomelo Note
+
+This is the best open source note app you will ever find.
+
+## Login
+When first entering the app, you will need to login. If you haven't got an account you may consider [registering](#register), or just not using the app at all.
+<br /><img src="images/login.png" width="50%" style="margin: auto; display: block;" />
+
+## Register
+A username, an email and a password that's all you need. If you are missing one of those, just don't use the app at all. 
+<br /><img src="images/register.png" width="50%" style="margin: auto; display: block;" />
+
+## Editor
+You can edit your notes with our minimalistic editor interface.
+<br /><img src="images/editor.png" width="50%" style="margin: auto; display: block;" />
+
+## Listing
+Here you can see all your notes. Click on them to open the editor or hover and press the red "X" to delete them.
+<br /><img src="images/listing.png" width="50%" style="margin: auto; display: block;" />
+
+## Delete
+Confirm the deletion.
+<br /><img src="images/delete.png" width="50%" style="margin: auto; display: block;" />
+
+# The Team
+{% for dev in site.data.devs %}
+  {{ dev.name }}
+  [GitHub](https://github.com/{{ dev.github }}) 
+  ![{{ dev.name }}](images/{{ dev.image }}.jpg)
+{% endfor %}
+