Skip to content

⚡️⚡️⚡️ Self-hosted collaborative bookmark manager to collect, read, annotate, and fully preserve what matters, all in one place.

Added readme

Daniel8463013322d0
diff --git a/README.md b/README.md
index a4c64f33..49001b18 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,21 @@
# Webmarker
-A bookmark manager
+### A simple bookmark manager for all your links and resources
-### Under Development...
+> This project is under development
+(error prone, missing features, etc...) feel free to contribute!
+
+<image src="assets/1" style="width:50%; float: left;"></image>
+<image src="assets/2" style="width:50%; float: left;"></image>
+
+## Setup
+### Linux/MacOS:
+1. Make sure the MongoDB database and collection is up and running.
+
+2. Edit `/src/config.json` accordingly.
+
+3. Head to the main folder using terminal and run: `(cd api && npm install) && npm install` for the dependancies.
+
+4. Run `(cd api && npm run dev) & npm start` to start the application.
+
+## Motivation
+One of the main reason I built this was so that I would start storing every information/resource I find in one place (Without any thirdparty services.)
diff --git a/assets/1 b/assets/1
new file mode 100644
index 00000000..85eb5825
Binary files /dev/null and b/assets/1 differ
diff --git a/assets/2 b/assets/2
new file mode 100644
index 00000000..a74b2395
Binary files /dev/null and b/assets/2 differ