Update and rename README.rst to README.md

README.rst → README.md

@@ -1,7 +1,6 @@
-ARL Python Tools
-================
+# ARL Python Tools
 
-[![CI](https://github.com/org-arl/arlpy.jl/workflows/CI/badge.svg)](https://github.com/org-arl/arlpy.jl/actions)
+[![CI](https://github.com/org-arl/arlpy/workflows/CI/badge.svg)](https://github.com/org-arl/arlpy/actions)
 
 Packages such as `numpy` and `scipy` provide excellent mathematical tools for
 scientists and engineers using Python. However, these packages are still young
@@ -11,53 +10,50 @@ gaps in the areas of underwater acoustics, signal processing, and communication.
 Additionally, `arlpy` also includes some commonly needed utilities and plotting
 routines based on `bokeh`.
 
-General modules
----------------
+## General modules
 
 The following modules are general and are likely to be of interest to researchers
 and developers working on signal processing, communication and underwater acoustics:
 
- * Signal processing (`arlpy.signal`)
- * Communications (`arlpy.comms`)
- * Beamforming and array processing (`arlpy.bf`)
- * Stable distributions (`arlpy.stable`)
- * Geographical coordinates (`arlpy.geo`)
- * Underwater acoustics (`arlpy.uwa`)
- * Underwater acoustic propagation modeling (`arlpy.uwapm`)
- * Plotting utilities (`arlpy.plot`)
- * Common utilities (`arlpy.utils`)
+* Signal processing (`arlpy.signal`)
+* Communications (`arlpy.comms`)
+* Beamforming and array processing (`arlpy.bf`)
+* Stable distributions (`arlpy.stable`)
+* Geographical coordinates (`arlpy.geo`)
+* Underwater acoustics (`arlpy.uwa`)
+* Underwater acoustic propagation modeling (`arlpy.uwapm`)
+* Plotting utilities (`arlpy.plot`)
+* Common utilities (`arlpy.utils`)
 
-Special-purpose modules
------------------------
+## Special-purpose modules
 
 The following modules are specific to tools available at the ARL and may not be of
 general interest to others:
 
- * Digital Towed Array (`arlpy.dtla`)
- * ROMANIS (`arlpy.romanis`)
- * HiDAQ (`arlpy.hidaq`)
- * UNET (`arlpy.unet`)
+* Digital Towed Array (`arlpy.dtla`)
+* ROMANIS (`arlpy.romanis`)
+* HiDAQ (`arlpy.hidaq`)
+* UNET (`arlpy.unet`)
 
-Usage
------
+## Usage
 
 Installation::
-
- pip install arlpy
+```
+pip install arlpy
+```
 
 To import all general modules::
+```
+import arlpy
+```
 
- import arlpy
-
-Notes
------
+## Notes
 
 Png export of bokeh plots requires `selenium`, `pillow` and `phantomjs`. These are not
 installed as automatic depdendencies, since they are optional and only required
 for png export. These should be installed manually, if desired.
 
-Useful links
-------------
+## Useful links
 
- * `arlpy home <https://github.com/org-arl/arlpy>`_
- * `arlpy documentation <http://arlpy.readthedocs.io>`_
+* `arlpy home <https://github.com/org-arl/arlpy>`_
+* `arlpy documentation <http://arlpy.readthedocs.io>`_