diff --git a/README.md b/README.md index e58142d..31242a4 100644 --- a/README.md +++ b/README.md @@ -53,27 +53,37 @@ To add a new plate, click the "New Plate" button: If you no longer need a transfer, select it as above and then click the "Delete" button. ### Importing and Exporting - + + #### Export as CSV Exporting the transfers we have created to a CSV format is the primary (if not sole) usage of Plate Tool. To do so, first note the "File" tab at the top-left of the screen (above the list pane). Mouse over this tab, and a few more options will be revealed. We want to export: mouse over export and select "Export as CSV". You will be reminded that this is a one-way export (see JSON export/import below), and then prompted by your browser to select a location for your file. - - Currently, it is not possible to import from nor export to a format produced by other similar software. + + #### Export as JSON (Saving Your Work) + Currently, it is not possible to export to a format produced by other similar software. However, you might reasonably want to save a copy of your work either as a backup or to share. Mouse over the "File" tab, then "Export" as above, then alternatively select "Export as JSON". Your browser will then prompt you to pick a suitable location to save your work as a file. (See note 1 below) - + + #### Import from JSON (Recovering Your Work) If we want to import one such file, mouse over the "File" tab as before - and select "Import". + and select "Import", and finally click "Import from JSON". This opens a modal where you are prompted to upload (see note 2) your file; it will then be processed and loaded. Keep in mind that this will overwrite any work you currently have open, so you may wish to export first (see above). + + #### Import Transfer from CSV (Using a picklist as a transfer) + If you have a CSV generated by another tool (or plate-tool), + you can import it as a single transfer. + To do so, mouse over the "File" tab, then "Import", and finally "Import Transfer from CSV". + When creating transfers via this method, the transfer cannot be edited. + This is useful if you have a pre-existing picklist that you would like to visualize in plate-tool. _Note 1_: JSON files are plaintext! By default there is little whitespace (this makes comprehending them a challenge)