Merge pull request #6 from inventree/docs

Add docs
inventree · Nov 18, 2024 · d97b6ae · d97b6ae
2 parents 4baffd3 + 884eafd
commit d97b6ae
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -9,16 +9,21 @@ An [InvenTree](https://inventree.org) plugin for generating and viewing statisti
 
 ## Description
 
-... TODO ...
+The *Test Statistics* plugin provides a number of tools for generating and viewing statistical test data, which can be displayed dynamically in the user interface, or exported to a file for further processing.
 
+Test statistics can be generated for a particular part, or for a selected build order.
+
+| Context | Screenshot |
+| --- | --- |
+| Test for a part (including variants) | ![Part Test Statistics](docs/img/stats.png) |
 
 ## Installation
 
 ### Via User Interface
 
 The simplest way to install this plugin is from the InvenTree plugin interface. Enter the plugin name (`inventree-test-statistics`) and click the `Install` button:
 
-... TODO ...
+![Install Plugin](docs/img/install.png)
 
 ### Via Pip
 
@@ -34,7 +39,7 @@ pip install -U inventree-test-statistics
 
 The plugin can be configured via the InvenTree plugin interface. The following settings are available:
 
-... TODO ...
+*TODO: No plugin settings are currently available*
 
 ## Contributing
 

diff --git a/docs/img/install.png b/docs/img/install.png
diff --git a/docs/img/part_stats.png b/docs/img/part_stats.png
diff --git a/test_statistics/version.py b/test_statistics/version.py
@@ -1,3 +1,3 @@
 """Version information for the inventree-test-statistics plugin."""
 
-PLUGIN_VERSION = "0.1.0"
+PLUGIN_VERSION = "0.1.1"