Update README.md

README.md

@@ -2,47 +2,39 @@
 [![pypi](https://img.shields.io/pypi/v/snirf2bids?color=blue)](https://pypi.org/project/snirf2bids/)
 [![tests](https://github.com/BUNPC/snirf2bids/actions/workflows/test.yml/badge.svg)](https://github.com/BUNPC/snirf2bids/actions/workflows/test.yml)
 
-# Installation
-
-`pip install snirf2bids`
-
-# Table of Contents
-- [Introduction](#snirf2bids)
-- [Features](#features)
-  - [Create BIDS Structures](#create-bids-compliant-structures)
-  - [Create BIDS Metadata Directory](#create-bids-compliant-metadata-directory)
-  - [Create BIDS Metadata Files in JSON Format](#create-bids-compliant-metadata-files-in-json-format)
-
-- [BIDS implementation](#bids-implementation)
-- [Contributors](#contributors)
-
 # snirf2BIDS
-Conveniently generate BIDS structures from [SNIRF files](https://github.com/fnirs/snirf).  
-
-[snirf2BIDS](https://pypi.org/project/snirf2bids/) requires [Python](https://www.python.org/downloads/) >3 and [h5py](https://www.h5py.org/) >3.6.
+Conveniently generate [BIDS files](https://bids-specification--802.org.readthedocs.build/en/802/04-modality-specific-files/11-functional-near-infrared-spectroscopy.html) from [SNIRF files](https://github.com/fnirs/snirf).  
 
-# Installation
+## Installation
+### `pip install snirf2bids`
 
-`pip install snirf2bids`
+snirf2bids requires Python > 3.
 
-# Features
-- Create BIDS text files from a SNIRF file
-- Export BIDS text files in JSON Format
+## Usage
+A SNIRF file with a [valid BIDS name](https://bids-specification.readthedocs.io/en/stable/02-common-principles.html#file-name-structure) can be converted into BIDS metadata text files.
 
-# BIDS implementation
+For use with snirf2bids, a SNIRF file name must include at least the `sub-` and `task-` entitites and end in `_nirs.snirf`, i.e. `sub-01_task-tapping_nirs.snirf`.
 
-The fields and descriptions in JSON files are based on the latest [Brain Imaging Data Structure v1.7.1-dev](https://bids-specification--802.org.readthedocs.build/en/stable/04-modality-specific-files/11-functional-near-infrared-spectroscopy.html#channels-description-_channelstsv) 
-and [SNIRF specification](https://github.com/fNIRS/snirf).
+### Create BIDS text files from a SNIRF file
+```python
+snirf2bids.snirf2bids('<path to snirf file>', '<folder to generate files in>')
+```
+### Export BIDS text files in JSON Format
+```python
+s = snirf2bids.snirf2json('<path to snirf file>')  # Returns serialized JSON in which keys are filenames and values are their contents
+```
 
-# Contributors
+## Contributors
 
 Developed by BU BME Senior Design Group 3 (2022): Christian Arthur, Jeonghoon Choi, Jiazhen Liu, Juncheng Zhang and the [Boston University Neurophotonics Center](https://github.com/BUNPC).
+
 [@Christian Arthur :melon:](https://github.com/chrsthur)<br>
 [@Juncheng Zhang :tangerine:](https://github.com/andyzjc)<br>
 [@Jeonghoon Choi :pineapple:](https://github.com/jeonghoonchoi)<br>
 [@Jiazhen Liu :grapes:](https://github.com/ELISALJZ)<br>
 
-This project exists thanks to: <br>
+This project exists thanks to:
+<br>
 <center class= "half">
 <a href="https://github.com/sstucker">
 <img src="https://github.com/sstucker.png" width="50" height="50">