upgrade readme

README.md

@@ -11,14 +11,12 @@
 
 # ocean-data-parser
 
-<!-- You can get project relevant badges from: [shields.io](https://shields.io/) -->
+<!-- You can get project-relevant badges from: [shields.io](https://shields.io/) -->
 
 [![Build documentation](https://github.com/cioos-siooc/ocean-data-parser/actions/workflows/deploy-docs.yaml/badge.svg)](https://github.com/cioos-siooc/ocean-data-parser/actions/workflows/deploy-docs.yaml)
 
 
-`ocean-data-parser` - a python package for parsing oceanographic proprietary data formats to [xarray Dataset](https://docs.xarray.dev/en/stable/).
-
-[A more detailed documentation is available here](https://cioos-siooc.github.io/ocean-data-parser/).
+`ocean-data-parser` - a Python package for parsing oceanographic proprietary data formats to [xarray Dataset](https://docs.xarray.dev/en/stable/). Documentation [here](https://cioos-siooc.github.io/ocean-data-parser/).
 
 ## Installation
 Install the package with the following command, ideally within a virtual environment:
@@ -27,18 +25,18 @@ Install the package with the following command, ideally within a virtual environ
 pip install git+https://github.com/cioos-siooc/ocean-data-parser.git
 ```
 
-### Examples
+### How to
 #### odpy cli
 Once installed, the package is usable via the command line interface:
 ```console
 odpy --help
 ```
 
-To batch convert a series of files to netcdf:
+To batch convert a series of files to NetCDF:
 ```
 odpy convert -i '**/*.cnv' -p 'seabird.cnv'
 ```
-#### format auto-detection
+#### Format auto-detection
 Load a compatible file with the automated parser detection method:
 
 ```python
@@ -50,7 +48,8 @@ ds = ocean_data_parser.parsers.file('Path to file')
 # Save to netcdf
 ds.to_netcdf('save-path.nc')
 ```
-> :warning: The parser detection method relies on the file extension and the first few lines present within the given file.
+!!!warning
+    The parser detection method relies on the file extension and the first few lines present within the given file.
 
 Or specify the specific parser to use for this file format:
 ``` python
@@ -62,10 +61,10 @@ ds = seabird.cnv('Path to seabird cnv file')
 # Save to netcdf
 ds.to_netcdf('save-path.nc')
 ```
-The `ocean-data-parser` can then be used within either a python package, script or jupyter notebook. See [documentation Notebook section](https://cioos-siooc.github.io/ocean-data-parser) for examples on how to use the package within a jupyter notebook.
+The `ocean-data-parser` can then be used within either a Python package, script or jupyter notebook. See the [documentation Notebook section](https://cioos-siooc.github.io/ocean-data-parser) for examples of how to use the package within a jupyter notebook.
 
 ## Contributions
 
 All contributions are welcome! 
 
-Please create a new [discussion](https://github.com/cioos-siooc/ocean-data-parser/discussions) or [issue](https://github.com/cioos-siooc/ocean-data-parser/issues) within the github repository for any questions, ideas and suggestions. 
+Please create a new [discussion](https://github.com/cioos-siooc/ocean-data-parser/discussions) or [issue](https://github.com/cioos-siooc/ocean-data-parser/issues) within the GitHub repository for any questions, ideas and suggestions.