Skip to content

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

updated README.md

Daniel4de6db772001
diff --git a/README.md b/README.md
index a95b1ebe..00d5ce2f 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,80 @@
<div align="center">
- <h1>
- Linkwarden
- </h1>
- <h3>Collect, Organize, and Preserve Links with Seamless Collaboration!</h3>
+ <img src="./assets/icon.png" width="100px" />
+ <h1>Linkwarden</h1>
- Rebuilding things from ground up (Almost ready).
+ <img src="./assets/showcase_image.png" />
+
+ <a href="https://discord.com/invite/CtuYV47nuJ"><img src="https://img.shields.io/discord/1117993124669702164?logo=discord&style=flat-square" alt="Discord"></a>
+ <img src="https://img.shields.io/github/commit-activity/m/linkwarden/linkwarden?style=flat-square" alt="Github Activity">
+ <img src="https://img.shields.io/github/languages/top/linkwarden/linkwarden?style=flat-square" alt="Top Language">
+ <img src="https://img.shields.io/github/stars/linkwarden/linkwarden?style=flat-square" alt="Github Stars">
+</div>
+
+<div align='center'>
-To get a better sense at what this repository is all about, you can check out the old version *[here](https://github.com/linkwarden/linkwarden-old)*.
+[Homepage](https://linkwarden.app) | [Docs](https://docs.linkwarden.app) | [Features](https://github.com/linkwarden/linkwarden#features) | [Roadmap](https://github.com/linkwarden/linkwarden#roadmap) | [Support ❤](https://github.com/linkwarden/linkwarden#support-❤)
-<h3>Thanks for your patience!</h3>
</div>
+## Intro & motivation
+
+**Linkwarden is a self-hosted, open-source collaborative bookmark manager to collect, organize and archive webpages.** The objective is to organize useful webpages and articles you find across the web in one place, and since useful webpages can go away (see the inevitability of [Link Rot](https://www.howtogeek.com/786227/what-is-link-rot-and-how-does-it-threaten-the-web/)), Linkwarden also saves a copy of each webpage as a Screenshot and PDF, ensuring accessibility even if the original content is no longer available.
+Additionally, Linkwarden is designed with collaboration in mind, sharing links with the public and/or allowing multiple users to work together seamlessly.
+
+<details>
+<summary><b>A bit of a "history"</b></summary>
+Linkwarden has been completely rebuilt and redesigned from ground up, so pretty much the only thing it has in common with its predecessor is the idea behind it - bookmark management.
+
+**What happened to the old version?**
+We highly recommend you **not** to use the old version as it is no longer maintained and has much less features. But anyway if you really wanna check it out, here it is in [this repo](https://github.com/linkwarden/linkwarden-old).
+
+</details>
+
+## Main Tech Stack
+
+- NextJS
+- TypeScript
+- Tailwind
+- Next-auth
+- Prisma
+
+## Features
+
+- ✅ Auto capture screenshot and PDF for each link.
+- ✅ Organize links by collection, name, description and multiple tags.
+- ✅ Collaborate with on gathering links in a collection.
+- ✅ Customize the permissions of each member.
+- ✅ Share your collected links with the world.
+- ✅ Search, filter and sort by link details.
+- ✅ Responsive design and works on all devices.
+
+## Roadmap
+
+_Some_ of the 100% planned todo’s are:
+
+- 🐳 Docker version.
+- 🌒 Dark mode.
+- 📦 Import/Export your data.
+
+There are many more upcoming features...
+
+## Development
+
+If you want to contribute, please start by creating an issue stating what you are going to work on based on the project roadmap.
+
+## Security
+
+If you found a security vulnerability, please do **not** create a public issue, instead send an email to [email protected] stating the vulnerability. Thanks!
+
+## Support ❤
+
+Any [donation’s](https://opencollective.com/linkwarden) are highly appreciated. <3
+
+Here are the other ways to support this project:
+
+- Starring this repo.
+- Joining us on Discord.
+- Following @daniel31x13 on [Mastodon](https://mastodon.social/@daniel31x13), [Twitter](https://twitter.com/Daniel31x13) and [GitHub](https://github.com/daniel31x13).
+- Referring Linkwarden to a friend.
+
+If you did any of the above, Thanksss! Otherwise thanks.
diff --git a/assets/icon.png b/assets/icon.png
new file mode 100644
index 00000000..cbdb11c4
Binary files /dev/null and b/assets/icon.png differ
diff --git a/assets/showcase_image.png b/assets/showcase_image.png
new file mode 100644
index 00000000..66dbc42d
Binary files /dev/null and b/assets/showcase_image.png differ