README updates for 0.1.0 release

README.md

@@ -8,11 +8,48 @@ Read data from [HEC-RAS](https://www.hec.usace.army.mil/software/hec-ras/) [HDF]
 *Pronunciation: `raz·aitch·dee·eff`*
 
 ## Install
-A prerelease version of `rashdf` is available from PyPI:
 ```bash
-$ pip install rashdf=0.1.0b1
+$ pip install rashdf
 ```
 
+## Usage
+`RasGeomHdf` and `RasPlanHdf` are extensions of
+[h5py.File](https://docs.h5py.org/en/stable/high/file.html#h5py.File). They contain
+methods to export HEC-RAS model geometry as
+[GeoDataFrame](https://geopandas.org/en/stable/docs/reference/geodataframe.html)
+objects.
+```python
+>>> from rashdf import RasGeomHdf
+>>> geom_hdf = RasGeomHdf("path/to/rasmodel/Muncie.g04.hdf")
+>>> mesh_cells = geom_hdf.mesh_cell_polygons()  # export a GeoDataFrame
+>>> mesh_cells
+             mesh_name  cell_id                                           geometry
+0     2D Interior Area        0  POLYGON ((406025.000 1805015.237, 406025.000 1...
+1     2D Interior Area        1  POLYGON ((406075.000 1805018.545, 406075.000 1...
+2     2D Interior Area        2  POLYGON ((406075.000 1804975.000, 406075.000 1...
+3     2D Interior Area        3  POLYGON ((406125.000 1804975.000, 406125.000 1...
+4     2D Interior Area        4  POLYGON ((406175.000 1804975.000, 406175.000 1...
+...                ...      ...                                                ...
+5386  2D Interior Area     5386  POLYGON ((409163.402 1802463.621, 409175.000 1...
+5387  2D Interior Area     5387  POLYGON ((409160.953 1802374.120, 409125.000 1...
+5388  2D Interior Area     5388  POLYGON ((409163.402 1802463.621, 409161.906 1...
+5389  2D Interior Area     5389  POLYGON ((409112.480 1802410.114, 409112.046 1...
+5390  2D Interior Area     5390  POLYGON ((409112.480 1802410.114, 409063.039 1...
+>>> mesh_cells.to_file("mucie-mesh-cell-polygons.shp")
+```
+
+Also, methods to extract certain HDF group attributes as dictionaries:
+```python
+>>> from rashdf import RasPlanHdf
+>>> with RasPlanHdf("path/to/rasmodel/Muncie.p04.hdf") as plan_hdf:
+>>>     results_unsteady_summary = plan_hdf.get_results_unsteady_summary()
+>>> results_unsteady_summary
+{'Computation Time DSS': '00:00:00', 'Computation Time Total': '00:00:23', 'Maximum WSEL Error': 0.0099277812987566, 'Maximum number of cores': 6, 'Run Time Window': [datetime.datetime(2024, 3, 27, 9, 31, 52), datetime.datetime(2024, 3, 27, 9, 32, 15)], 'Solution': 'Unsteady Finished Successfully', 'Time Solution Went Unstable': None, 'Time Stamp Solution Went Unstable': 'Not Applicable'}
+```
+
+## Documentation
+Coming soon.
+
 ## Developer Setup
 Create a virtual environment in the project directory:
 ```