Documentation improvements

README.md

@@ -32,8 +32,12 @@ Our documentation can be found [here](https://aerovaldb.readthedocs.io/)
 9. To be discussed: do we want to allow the programmer to set open-modes, e.g. 'r', 'rw', 'w'?
 
 ## Installation
-`python -m pip install 'aerovaldb@git+https://github.com/metno/aerovaldb.git'`
 
+The most recent stable version of aerovaldb can be installed from pypi like this:
+- `pip install aerovaldb`
+
+Development versions can be installed directly from Github like this:
+`pip install 'aerovaldb@git+https://github.com/metno/aerovaldb.git'`
 
 ## Usage
 
@@ -97,7 +101,7 @@ with aerovaldb.open('json_files:path/to/data/') as db:
 
 ## COPYRIGHT
 
-Copyright (C) 2024  Augustin Mortier, Thorbjørn Lunding, Heiko Klein, Norwegian Meteorological Institute
+Copyright (C) 2024  Augustin Mortier, Thorbjørn Lundin, Heiko Klein, Norwegian Meteorological Institute
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public

docs/extending-aerovaldb.rst

@@ -0,0 +1,9 @@
+Extending AerovalDB
+===================
+
+AerovalDB is designed to allow custom implementations to allow storage in new storage formats. This is done by writing a new class inheriting from :class:`aerovaldb.AerovalDB`.
+
+Unless overridden, getters and setters will be routed to :meth:`aerovaldb.AerovalDB._get` and :meth:`aerovaldb.AerovalDB._put` respectively, so this is were the main read and write behaviour should be implemented. These functions receive a route, as well as arguments based on which to get/put data and are intended to be used based on route-lookup (for example, :class:`aerovaldb.jsondb.jsonfiledb.AerovalJsonFileDB` translates the route into a file path template, while :class:`aerovaldb.sqlitedb.sqlitedb.AerovalSqliteDB` translates the route into a table name).
+
+URI Scheme
+----------

docs/index.rst

@@ -52,6 +52,7 @@ Writing
    installation
    api
    locking
+   extending-aerovaldb
    genindex
 
 Indices and tables

docs/installation.rst

@@ -3,21 +3,24 @@ Installation
 
 You can install aerovaldb via pip or from source.
 
-Via pip
-^^^^^^^
+Latest Stable Release:
+^^^^^^^^^^^^^^^^^^^^^^
 
-This will install the latest aerovaldb and all its dependencies.
+This will install the latest stable aerovaldb version from PyPi:
 ::
+	pip install aerovaldb
 
-	# install aerovaldb
-	python -m pip install aerovaldb@git+https://github.com/metno/aerovaldb@main
+Development releases:
+^^^^^^^^^^^^^^^^^^^^^
 
+This will install the most recent development version from Github:
+::
+	pip install git+https://github.com/metno/aerovaldb.git@main
 
 From source:
-^^^^^^^
-::
+^^^^^^^^^^^^
 
-	# install aerovaldb on machines with numpy
+::
 	git clone https://github.com/metno/aerovaldb.git
 	cd aerovaldb
 	python -m pip install .