Update README.md

README.md

@@ -8,4 +8,28 @@ pinned: false
 license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+<!-- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference -->
+
+# Dev Dashboard Prototype
+
+This space is dedicated to testing development changes to the [Imageomics Data Dashboard](https://huggingface.co/spaces/imageomics/dashboard-prototype) prior to production.
+It runs off a dockerfile generated from the [development branch](https://github.com/Imageomics/dashboard-prototype/tree/dev) of the [dashboard repo](https://github.com/Imageomics/dashboard-prototype).
+
+For more information or to make your own version, see the [GitHub project repo](https://github.com/Imageomics/dashboard-prototype).
+
+## How it works
+
+For full dashboard functionality, upload a CSV or XLS file with the following columns: 
+- `Image_filename`*: Filename of each image, must be unique. **Note:** Images should be in PNG or JPEG format, TIFF may fail to render in the sample image display.
+- `Species`: Species of each sample.
+- `Subspecies`: Subspecies of each sample.
+- `View`: View of the sample (eg., 'ventral' or 'dorsal' for butterflies).
+- `Sex`: Sex of each sample.
+- `hybrid_stat`: Hybrid status of each sample (eg., 'valid_subspecies', 'subspecies_synonym', or 'unknown').
+- `lat`*: Latitude at which image was taken or specimen was collected.
+- `lon`*: Longitude at which image was taken or specimen was collected.
+- `file_url`*: URL to access file.
+
+***Note:** 
+- `lat` and `lon` columns are not required to utilize the dashboard, but there will be no map view if they are not included.
+- `Image_filename` and `file_url` are not required, but there will be no sample images option if either one is not included.