Merge pull request bids-standard#84 from Remi-Gau/remi-update_readme

[DOC] Describe what bids-matlab can and cannot do

README.md

@@ -15,6 +15,30 @@ Join our chat on the [bids-matlab channel](https://mattermost.brainhack.org/brai
 See also [PyBIDS](https://github.com/bids-standard/pybids) for Python and the [BIDS Starter Kit](https://github.com/bids-standard/bids-starter-kit).
 
 
+## Features
+
+### What this toolbox can do
+
+- read the layout of a BIDS dataset (see `bids.layout`),
+- perform queries on that layout to get information about the subjects, sessions, runs, modalities, metadata... contained within that dataset (see `bids.query`),
+- generate a human readable report of the content of BIDS data set containing anatomical MRI, functional MRI, diffusion weighted imaging, field map data (see `bids.report`)
+- read and write JSON files (see `bids.util.jsondecode` and `bids.util.jsonencode`) provided that the right [dependencies](#reading-and-writing-json-files) are installed,
+- read and write TSV files (see `bids.util.tsvread` and `bids.util.tsvwrite`),
+
+The behavior of this toolbox assumes that it is interacting with a valid BIDS dataset that should have been validated using [BIDS-validator](https://bids-standard.github.io/bids-validator/). If the Node.js version of the validator is [installed on your computer](https://github.com/bids-standard/bids-validator#quickstart), you can call it from the matlab prompt using `bids.validate`. Just be aware that any unvalidated components may produce undefined behavior. Although, if you're BIDS-y enough, the behavior may be predictable.
+
+
+### What this toolbox cannot do... yet
+
+- parse the layout of "BIDS-derivative compatible" datasets (like those generated by fMRIprep),
+- create BIDS compatible filenames or folder structures for raw or derivatives datasets,
+- do basic copying of files to help with derivative dataset generation,
+- generate human readable reports of the content of BIDS data with EEG, MEG, iEEG, physio and events data,
+- deal with some of the most recent updates or incoming BIDS extensions (basic derivatives, ASL, PET, BIDS model...)
+- ...
+
+We are trying to centralize the requests for new features in this [issue](https://github.com/bids-standard/bids-matlab/issues/60): have a browse to see what could be coming soon or if we have missed something obvious.
+
 
 ## Installation
 
@@ -37,7 +61,15 @@ A [tutorial](https://github.com/bids-standard/bids-matlab/blob/master/examples/t
 
 ## Requirements
 
-BIDS-MATLAB works with MATLAB R2014a or newer, or Octave 4.2.2 or newer. (It may also work with older versions, but those are not actively supported.)
+BIDS-MATLAB works with: 
+
+- Octave 5.2.0 or newer
+- MATLAB R2014a or newer  
+
+We aim for compatibility with the latest stable release of Octave at any time. Compatibility can sometimes also be achieved with older versions of Octave but this is not guaranteed.
+
+
+### Reading and writing JSON files
 
 If you are using MATLAB R2016b or newer, nothing else needs to be installed.