Merge branch 'main' of https://github.com/cupcakearmy/cryptgeon

README.md

@@ -1,3 +1,43 @@
-#  cryptgeon
+<p align="center">
+<img src="./design/Logo.svg">
+</p>
 
-<div>Icons made by <a href="https://www.freepik.com" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>
+## About?
+
+_cryptgeon_ is an secure, open source sharing note service inspired by [_PrivNote_](https://privnote.com)
+
+## Features
+
+- view and time constrains
+- in memory, no persistence
+- in browser encryption → server cannot decrypt contents
+
+
+## How does it work?
+
+each note has a 512bit generated <i>id</i> that is used to retrieve the note. data is stored in memory and never persisted to disk.
+
+## Deployment
+
+Docker is the easiest way.
+
+```yaml
+# docker-compose.yml
+
+version: '3.7'
+
+services:
+  memcached:
+    image: memcached:1-alpine
+    entrypoint: memcached -m 128
+
+  app:
+    image: cupcakearmy/cryptgeon:latest
+    ports:
+      - 80:5000
+
+```
+
+###### Attributions
+
+Icons made by <a href="https://www.freepik.com" title="Freepik">freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>