diff --git a/README.md b/README.md index 1630039874d1385be060d7b71e0a1cc0e62ff8e8..099103e02a347e829939c53304ca5f8c8686e625 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,17 @@ The **ProjectID** is your custom project number, it well be the prefix of the ID `DataPaths` contains the path(s) to the research data, for multiple files you can use a cell array (We recommend using absolute paths). It is also possible to pass an arbitrary number of variables as struct. \ `figure` is the figure that should be published. +** Minimal Example:** +```matlab +fig = figure; +plot(x,y); +[fig, IDs] = PlotID.TagPlot(fig); +script = [mfilename('fullpath'),'.m']; % This creates a path to the script this line is called from +rdata = {'\\fullpath\dataset01.mat', '\\fullpath\dataset02.h5'} ; % a single path does not need a cell array +PlotID.Publish(rdata, script, fig); +``` + + **Please take also a look on the examples provided in the Example folder**. @@ -122,6 +133,9 @@ The config file is a JSON-File. The config file stores user data and options of **Note:** If you mess up your config-file simply delete it, PlotID will create a new one the next time you use it. +## Default config.json + + ## Define an export path If you define an export path in the config.json this path is used as location for the exported data.