Merge pull request #35 from simple-repository/fix/readme

Fix markdown and add missing info in README

Author: pelson

.markdownlint.yaml

@@ -0,0 +1,2 @@
+MD013:
+  line_length: 200

.pre-commit-config.yaml

@@ -5,3 +5,11 @@ repos:
       - id: ruff-check
         args: ["--fix", "--select=I"]
       - id: ruff-format
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.46.0
+    hooks:
+      - id: markdownlint
+        args:
+          - '--config'
+          - './.markdownlint.yaml'
+          - '--'

README.md

@@ -6,7 +6,7 @@ Built using FastAPI and the [simple-repository](https://github.com/simple-reposi
 
 ## Demo
 
-A tech-preview demo is available at https://simple-repository.app.cern.ch/.
+A tech-preview demo is available at <https://simple-repository.app.cern.ch/>.
 
 ## Usage
 
@@ -24,39 +24,34 @@ simple-repository-browser
 
 (or alternatively ``python -m simple_repository_browser``)
 
-By default, this will use the repository at PyPI (https://pypi.org/simple/). You can point it to a custom
+By default, this will use the repository at PyPI (<https://pypi.org/simple/>). You can point it to a custom
 repository by passing the URL to the project list endpoint (the base URL according to PEP-503):
 
 ```bash
 simple-repository-browser https://my-custom-repository.example.com/foo/simple/
 ```
 
-## Screenshots:
+## Screenshots
 
 Homepage:
 
 ![homepage screenshot](https://raw.githubusercontent.com/simple-repository/simple-repository-browser/main/screenshots/home.png)
 
-
 Search:
 
 ![search result](https://raw.githubusercontent.com/simple-repository/simple-repository-browser/main/screenshots/search.png)
 
-
 Project page:
 
 ![example project page](https://raw.githubusercontent.com/simple-repository/simple-repository-browser/main/screenshots/project.png)
 
-
-
 ## Runtime details
 
 ```simple-repository-browser``` exposes a FastAPI application, and it runs the application in a single ``uvicorn`` worker.
 Metadata that is computed will be cached in the ``$XDG_CACHE_DIR/simple-repository-browser`` directory. This cache is not
 intended to be shared among different repository URLs, and is unlikely to work for multiple ``simple-repository-browser``
 versions. There is currently no intelligent cache invalidation for those cases.
 
-
 ## Development
 
 In order to build the ``simple-repository-browser`` you will need access to npm. If not available on the development host,
@@ -82,6 +77,12 @@ And then the normal installation procedure applies:
 python -m pip install -e .
 ```
 
+You may want to disable the indexing to avoid long-running tasks during the development:
+
+```bash
+export DISABLE_REPOSITORY_INDEXING=1
+```
+
 The browser can be run with:
 
 ```bash