Skip to content

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

update readme

daniel31x13e24e338e6737
diff --git a/README.md b/README.md
index 51447c7c..a77bbb8d 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
<div align="center">
<img src="./assets/logo.png" width="100px" />
<h1>Linkwarden</h1>
- <h3>Bookmark Preservation for Individuals and Teams</h3>
+ <h3>Bookmarks, Evolved</h3>
<a href="https://discord.com/invite/CtuYV47nuJ"><img src="https://img.shields.io/discord/1117993124669702164?logo=discord&style=flat" alt="Discord"></a>
<a href="https://twitter.com/LinkwardenHQ"><img src="https://img.shields.io/twitter/follow/linkwarden" alt="Twitter"></a> <a href="https://news.ycombinator.com/item?id=36942308"><img src="https://img.shields.io/badge/Hacker%20News-280-%23FF6600"></img></a>
@@ -19,42 +19,27 @@
[Cloud](https://cloud.linkwarden.app) · [Website](https://linkwarden.app) · [Features](https://github.com/linkwarden/linkwarden#features) · [Docs](https://docs.linkwarden.app)
+<img src="./assets/home.png" />
+
</div>
## Intro & motivation
-**Linkwarden is a self-hosted, open-source collaborative bookmark manager to collect, organize and archive webpages.**
+**Linkwarden is a self-hosted, open-source collaborative bookmark manager to collect, read, annotate, and fully preserve what matters, all in one place.**
+
+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://en.wikipedia.org/wiki/Link_rot)), Linkwarden also saves a copy of each webpage as a Screenshot and PDF, ensuring accessibility even if the original content is no longer available.
-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.
+In addition to preservation, Linkwarden provides a user-friendly reading and annotation experience that blends the simplicity of a “read-it-later” tool with the reliability of a web archive. Whether you’re highlighting key ideas, jotting down thoughts, or revisiting content long after it’s disappeared from the web, Linkwarden keeps your knowledge accessible and organized.
-Additionally, Linkwarden is designed with collaboration in mind, sharing links with the public and/or allowing multiple users to work together seamlessly.
+Linkwarden is also designed with collaboration in mind, enabling you to share links with the public and/or collaborate seamlessly with multiple users.
> [!TIP]
> Our official [Cloud](https://linkwarden.app/#pricing) offering provides the simplest way to begin using Linkwarden and it's the preferred choice for many due to its time-saving benefits. <br> Your subscription supports our hosting infrastructure and ongoing development. <br> Alternatively, if you prefer self-hosting Linkwarden, you can do so by following our [Installation documentation](https://docs.linkwarden.app/self-hosting/installation).
-<img src="./assets/dashboard.png" />
-
-<div align="center">
-<img src="./assets/all_links.jpg" width="23%" />
-
-<img src="./assets/list_view.jpg" width="23%" />
-
-<img src="./assets/all_collections.jpg" width="23%" />
-
-<img src="./assets/manage_team.jpg" width="23%" />
-
-<img src="./assets/readable_view.jpg" width="23%" />
-
-<img src="./assets/preserved_formats.jpg" width="23%" />
-
-<img src="./assets/public_page.jpg" width="23%" />
-
-<img src="./assets/light_dashboard.jpg" width="23%" />
-</div>
-
## Features
-- 📸 Auto capture a screenshot, PDF, single html file, and readable view of each webpage.
+- 📸 Auto capture a screenshot, PDF, and single html file of each webpage.
+- 📖 Reader view of the webpage, with the ability to highlight and annotate text.
- 🏛️ Send your webpage to Wayback Machine ([archive.org](https://archive.org)) for a snapshot. (Optional)
- ✨ Local AI Tagging to automatically tag your links based on their content (Optional).
- 📂 Organize links by collection, sub-collection, name, description and multiple tags.
diff --git a/apps/web/components/Navbar.tsx b/apps/web/components/Navbar.tsx
index 78a2a5a3..1d9814c8 100644
--- a/apps/web/components/Navbar.tsx
+++ b/apps/web/components/Navbar.tsx
@@ -67,10 +67,10 @@ export default function Navbar() {
<SearchBar />
<div className="flex items-center gap-2">
- <ToggleDarkMode className="hidden sm:inline-grid" />
+ <ToggleDarkMode hideInMobile />
<DropdownMenu>
- <DropdownMenuTrigger>
+ <DropdownMenuTrigger className="hidden sm:inline-grid">
<TooltipProvider>
<Tooltip>
<TooltipTrigger>
diff --git a/apps/web/components/ToggleDarkMode.tsx b/apps/web/components/ToggleDarkMode.tsx
index 14d47973..d73e8b3b 100644
--- a/apps/web/components/ToggleDarkMode.tsx
+++ b/apps/web/components/ToggleDarkMode.tsx
@@ -10,11 +10,11 @@ import {
import { useUpdateUserPreference, useUser } from "@linkwarden/router/user";
type Props = {
- className?: string;
+ hideInMobile?: boolean;
align?: "left" | "right" | "top" | "bottom";
};
-export default function ToggleDarkMode({ className, align }: Props) {
+export default function ToggleDarkMode({ hideInMobile, align }: Props) {
const { t } = useTranslation();
const { data } = useUser();
const updateUserPreference = useUpdateUserPreference();
@@ -28,14 +28,12 @@ export default function ToggleDarkMode({ className, align }: Props) {
return (
<TooltipProvider>
<Tooltip>
- <TooltipTrigger>
+ <TooltipTrigger className={hideInMobile ? "hidden sm:inline-grid" : ""}>
<Button
asChild
variant="ghost"
size="icon"
- className={`inline-grid swap swap-rotate text-neutral ${
- className || ""
- }`}
+ className={"inline-grid swap swap-rotate text-neutral"}
>
<label>
<input
diff --git a/assets/all_collections.jpg b/assets/all_collections.jpg
deleted file mode 100644
index fcee4e1a..00000000
Binary files a/assets/all_collections.jpg and /dev/null differ
diff --git a/assets/all_links.jpg b/assets/all_links.jpg
deleted file mode 100644
index 47f5abcd..00000000
Binary files a/assets/all_links.jpg and /dev/null differ
diff --git a/assets/dashboard.png b/assets/dashboard.png
deleted file mode 100644
index 0fd00c90..00000000
Binary files a/assets/dashboard.png and /dev/null differ
diff --git a/assets/home.png b/assets/home.png
new file mode 100644
index 00000000..2fb7d143
Binary files /dev/null and b/assets/home.png differ
diff --git a/assets/light_dashboard.jpg b/assets/light_dashboard.jpg
deleted file mode 100644
index c29d090e..00000000
Binary files a/assets/light_dashboard.jpg and /dev/null differ
diff --git a/assets/list_view.jpg b/assets/list_view.jpg
deleted file mode 100644
index 54e2f489..00000000
Binary files a/assets/list_view.jpg and /dev/null differ
diff --git a/assets/manage_team.jpg b/assets/manage_team.jpg
deleted file mode 100644
index 7b5f07bb..00000000
Binary files a/assets/manage_team.jpg and /dev/null differ
diff --git a/assets/preserved_formats.jpg b/assets/preserved_formats.jpg
deleted file mode 100644
index f6141db7..00000000
Binary files a/assets/preserved_formats.jpg and /dev/null differ
diff --git a/assets/public_page.jpg b/assets/public_page.jpg
deleted file mode 100644
index 6032ee83..00000000
Binary files a/assets/public_page.jpg and /dev/null differ
diff --git a/assets/readable_view.jpg b/assets/readable_view.jpg
deleted file mode 100644
index 50b2a0f6..00000000
Binary files a/assets/readable_view.jpg and /dev/null differ