diff --git a/README.md b/README.md index c4a13ad..9819dfb 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,33 @@ This repository contains demo data for the [InvenTree project](https://inventree The demo dataset can be used to populate an InvenTree database for demonstration purposes. It may also be useful if you are developing and/or testing new features for InvenTree. To setup InvenTree with this dataset, refer to the [InvenTree Instructions](https://inventree.readthedocs.io/en/latest/start/demo/). + +## Contribute + +Contributions to the demo dataset are encouraged! A richer dataset provides a better demo experience and helps to showcase the various features available in InvenTree. + +To contribute back to the InvenTree demo dataset: + +### Import Data + +Follow the directions above to create an InvenTree instance using the latest demo dataset + +### Git Branch + +Create a git branch for the demo-dataset repository + +### Edit Data + +Create / edit / update the InvenTree database and media files as required + +### Export Data + +Export the updated data, overwriting the original data file: + +``` +invoke export-records -f ~/inventree-data/inventree_data.json +``` + +### Create Pull Request + +Create a pull request on the [demo-dataset repository](https://github.com/inventree/demo-dataset) with the changes you have made.