Update README

2020-10-10 14:48:56 +02:00
parent ec638c8726
commit b3a7151614
2 changed files with 44 additions and 4 deletions
@@ -1,5 +1,45 @@
-# notion clone
+# 📓 Notion Clone
+#### Create and Edit Notes like in Notion

-### Stack
-Frontend: Next.js, Context API, CSS Modules
-Backend: Node.js, Express.js, MongoDB, Mongoose, JWT
+This clone tries to replicate some of the great note-taking features Notion has. If you don't know [Notion.so](https://notion.so) yet, I highly recommend to check it out!
+
+👋 Live Demo: *tba*
+
+---
+
+<img alt="notion clone screenshot" src="./screenshot.gif" width="480">
+
+---
+
+## Features
+
+* **Slash Commands** (Type `/` to turn the block into different content types)
+* **HTML Support** (Use regular HTML tags like `<a>` in text blocks)
+* **Image Support** (Upload images by using the `/image` command)
+* **Drag And Drop** (Reorder blocks easily by drag and drop)
+* **Guest Editing** (Anyone can create public pages and share them via link)
+* **User Management** (Create an account to create private pages)
+
+## Tech Stack
+
+The frontend is built with Next.js and fully server-side rendered. On the backend, a REST API handles saving user content and user management.
+
+#### Frontend
+Next.js · React.js · SCSS/SASS
+
+#### Backend
+Express.js · MongoDB with Mongoose · Nodemailer · JWT (Cookie-based)
+
+
+## Installation
+
+*tba*
+
+## About
+
+Konstantin Münster – [konstantin.digital](https://konstantin.digital) – [mail@konstantin.digital](mailto:mail@konstantin.digital)
+
+Distributed under the [MIT](http://showalicense.com/?fullname=Konstantin+M%C3%BCnster&year=2019#license-mit) license. 
+See ``LICENSE`` for more information.
+
+[https://github.com/konstantinmuenster](https://github.com/konstantinmuenster)