Doc improvements (#97)

* Improve docs

* Improve docs

README.md

@@ -1,12 +1,29 @@
 #  linkding
 
-*linkding* is a simple bookmark service that you can host yourself. It supports managing bookmarks, categorizing them with tags and has a search function. It provides a bookmarklet for quickly adding new bookmarks while browsing the web. It also supports import / export of bookmarks in the Netscape HTML format. And that's basically it 🙂.
+*linkding* is a simple bookmark service that you can host yourself.
+It's designed be to be minimal, fast and easy to set up using Docker. 
 
 The name comes from:
 - *link* which is often used as a synonym for URLs and bookmarks in common language
 - *Ding* which is german for *thing*
 - ...so basically some thing for managing your links
 
+**Feature Overview:**
+- Tags for organizing bookmarks
+- Search by text or tags
+- Automatically provides titles and descriptions from linked websites 
+- Import and export bookmarks in Netscape HTML format
+- Bookmark archive
+- Extensions for [Firefox](https://addons.mozilla.org/de/firefox/addon/linkding-extension/) and [Chrome](https://chrome.google.com/webstore/detail/linkding-extension/beakmhbijpdhipnjhnclmhgjlddhidpe)
+- Bookmarklet that should work in most browsers
+- Easy to set up using Docker
+- Uses SQLite as database
+- Works without Javascript
+- ...but has several UI enhancements when Javascript is enabled
+- REST API for developing 3rd party apps
+- Admin panel for user self-service and bulk operations
+
+
 **Demo:** https://demo.linkding.link/ (configured with open registration)
 
 **Screenshot:**
@@ -15,7 +32,7 @@ The name comes from:
 
 ## Installation
 
-The easiest way to run linkding is to use [Docker](https://docs.docker.com/get-started/).  The Docker image should be compatible with ARM platforms, so it can be run on a Raspberry Pi.
+The easiest way to run linkding is to use [Docker](https://docs.docker.com/get-started/).  The Docker image is compatible with ARM platforms, so it can be run on a Raspberry Pi.
 
 There is also the option to set up the installation manually which I do not support, but can give some pointers on below.
 
@@ -49,7 +66,7 @@ docker-compose up -d
 
 ### User setup
 
-Finally you need to create a user so that you can access the frontend. Replace the credentials in the following command and run it:
+Finally you need to create a user so that you can access the application. Replace the credentials in the following command and run it:
 
 **Docker**
 ```shell
@@ -67,10 +84,6 @@ The command will prompt you for a secure password. After the command has complet
 
 If you can not or don't want to use Docker you can install the application manually on your server. To do so you can basically follow the steps from the *Development* section below while cross-referencing the `Dockerfile` and `bootstrap.sh` on how to make the application production-ready.
 
-### Options
-
-Check the [options document](Options.md) on how to configure your linkding installation.
-
 ### Hosting
 
 The application runs in a web-server called [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/) that is production-ready and that you can expose to the web. If you don't know how to configure your server to expose the application to the web there are several more steps involved. I can not support support the process here, but I can give some pointers on what to search for:
@@ -78,13 +91,17 @@ The application runs in a web-server called [uWSGI](https://uwsgi-docs.readthedo
 - open the port that the application is running on in your servers firewall
 - depending on your network configuration, forward the opened port in your network router, so that the application can be addressed from the internet using your public IP address and the opened port
 
-### Backups
+## Options
+
+Check the [options document](docs/Options.md) on how to configure your linkding installation.
+
+## Backups
 
 Check the [backups document](docs/backup.md) for options on how to create backups.
 
 ## API
 
-The application provides a REST API that can be used by 3rd party applications to manage bookmarks. Check the [API docs](API.md) for further information.
+The application provides a REST API that can be used by 3rd party applications to manage bookmarks. Check the [API docs](docs/API.md) for further information.
 
 ## Troubleshooting
 

bookmarks/templates/bookmarks/empty_bookmarks.html

@@ -3,6 +3,6 @@
     <p class="empty-subtitle">
         You can get started by <a href="{% url 'bookmarks:new' %}">adding</a> bookmarks,
         <a href="{% url 'bookmarks:settings.data' %}">importing</a> your existing bookmarks or configuring the
-        <a href="{% url 'bookmarks:settings.integrations' %}">bookmarklet</a>.
+        <a href="{% url 'bookmarks:settings.integrations' %}">browser extension</a> or the <a href="{% url 'bookmarks:settings.integrations' %}">bookmarklet</a>.
     </p>
 </div>

bookmarks/templates/settings/integrations.html

@@ -7,8 +7,15 @@
 
         {# Integrations section #}
         <section class="content-area">
+            <h2>Browser Extension</h2>
+            <p>The browser extension allows you to quickly add new bookmarks without leaving the page that you are on. The extension is available in the official extension stores for:</p>
+            <ul>
+                <li><a href="https://addons.mozilla.org/de/firefox/addon/linkding-extension/" target="_blank">Firefox</a></li>
+                <li><a href="https://chrome.google.com/webstore/detail/linkding-extension/beakmhbijpdhipnjhnclmhgjlddhidpe" target="_blank">Chrome</a></li>
+            </ul>
+            <p>The extension is <a href="https://github.com/sissbruecker/linkding-extension" target="_blank">open source</a> as well, which enables you to build and manually load it into any browser that supports Chrome extensions.</p>
             <h2>Bookmarklet</h2>
-            <p>The bookmarklet is a quick way to add new bookmarks without opening the linkding application
+            <p>The bookmarklet is an alternative, cross-browser way to quickly add new bookmarks without opening the linkding application
                 first. Here's how it works:</p>
             <ul>
                 <li>Drag the bookmarklet below into your browsers bookmark bar / toolbar</li>

build-docker.sh

@@ -2,7 +2,6 @@
 
 version=$(<version.txt)
 
-./build-static.sh
 docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v7 \
   -t sissbruecker/linkding:latest \
   -t sissbruecker/linkding:$version \

docs/backup.md

@@ -10,7 +10,7 @@ The location of the database file is `data/db.sqlite3` in the application folder
 If you are using Docker then the full path in the Docker container is `/etc/linkding/data/db.sqlite`. 
 As described in the installation docs, you should mount the `/etc/linkding/data` folder to a folder on your host system, from which you then can execute the backup.
 
-Below, we describe two methods to create a backup of the database:
+Below, we describe several methods to create a backup of the database:
 
 - Manual backup using the export function from the UI
 - Create a copy of the SQLite databse with the SQLite backup function
@@ -23,7 +23,7 @@ Choose the method that fits you best.
 The least technical option is to use the bookmark export in the UI.
 Go to the settings page and open the *Data* tab. 
 Then click on the *Download* button to download an HTML file containing all your bookmarks.
-Then backup this file on a drive, or an online file host.
+You can backup this file on a drive, or an online file host.
 
 ## Using the SQLite backup function