Merge pull request #136 from NOAA-GFDL/main

.

Author: Ciheim

README.md

@@ -1,7 +1,28 @@
 # CatalogBuilder
 
+The GFDL Catalog Builder is a python community package ecosystem that allows users to generate data catalogs compatible with intake-esm.
+
+Data catalogs simplify data discovery by creating customizable, extendable, and queryable catalogs.
+
+To use the catalog builder, install the [conda package](https://anaconda.org/NOAA-GFDL/catalogbuilder), clone the [github repository](https://github.com/NOAA-GFDL/CatalogBuilder), or use the [FRE command line interface](https://github.com/NOAA-GFDL/fre-cli).
+
+
+Building a catalog would then look something like this: 
+
+``` 
+gen_intake_gfdl.py /archive/path_to_data_dir /home/$USER/catalog
+```
+
+OR
+
+``` 
+fre catalog build /archive/path_to_data_dir /home/$USER/catalog
+```
+
+If you run into any problems please create an [issue](https://github.com/NOAA-GFDL/CatalogBuilder/issues) here.
+
 Cite our work: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5196586.svg)](https://doi.org/10.5281/zenodo.10787602)
 
-See our [project documentation site ](https://noaa-gfdl.github.io/CatalogBuilder/).
+For detailed information regarding the Catalog Builder, see our [project documentation site ](https://noaa-gfdl.github.io/CatalogBuilder/).
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!