From 0b2b7ca2bdf1230fd7e2e735e9176f178b1b0491 Mon Sep 17 00:00:00 2001
From: Nick Budak <budak@stanford.edu>
Date: Wed, 13 Sep 2023 12:40:03 -0700
Subject: [PATCH] Update the README

---
 README.md | 32 ++++++++++++++++++++++++++------
 1 file changed, 26 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 9ee1291..d41cdcf 100644
--- a/README.md
+++ b/README.md
@@ -28,22 +28,35 @@ Or install it yourself as:
 ## Usage
 
 ### Converting metadata
-
+#### Converting metadata into GeoBlacklight JSON
+GeoCombine provides several classes representing different metadata standards that implement the `#to_geoblacklight` method for generating records in the [GeoBlacklight JSON format](https://opengeometadata.org/reference/):
+```ruby
+GeoCombine::Iso19139 # ISO 19139 XML
+GeoCombine::OGP # OpenGeoPortal JSON
+GeoCombine::Fgdc # FGDC XML
+GeoCombine::EsriOpenData # Esri Open Data Portal JSON
+GeoCombine::CkanMetadata # CKAN JSON
+```
+An example for converting an ISO 19139 XML record:
 ```ruby
 # Create a new ISO19139 object
 > iso_metadata =  GeoCombine::Iso19139.new('./tmp/opengeometadata/edu.stanford.purl/bb/338/jh/0716/iso19139.xml')
 
-# Convert ISO to GeoBlacklight
+# Convert to GeoBlacklight's metadata format
 > iso_metadata.to_geoblacklight
 
-# Convert that to JSON
+# Output it as JSON instead of a Ruby hash
 > iso_metadata.to_geoblacklight.to_json
+```
+Some formats also support conversion into HTML for display in a web browser:
+```ruby
+# Create a new ISO19139 object
+> iso_metadata =  GeoCombine::Iso19139.new('./tmp/opengeometadata/edu.stanford.purl/bb/338/jh/0716/iso19139.xml')
 
-# Convert ISO (or FGDC) to HTML
+# Convert ISO to HTML
 > iso_metadata.to_html
 ```
-
-### OpenGeoMetadata
+### Downloading metadata from OpenGeoMetadata
 
 #### Clone OpenGeoMetadata repositories locally
 
@@ -98,6 +111,13 @@ To index into Solr, GeoCombine requires a Solr instance that is running the
 $ bundle exec rake geocombine:index
 ```
 
+By default, GeoCombine will index only records using the Aardvark metadata format. If you instead want to index records using an older format (e.g. because your GeoBlacklight instance is version 3 or older), you can set the `SCHEMA_VERSION` environment variable:
+
+```sh
+# Only index schema version 1.0 records
+$ SCHEMA_VERSION=1.0 bundle exec rake geocombine:index
+```
+
 Indexes the `geoblacklight.json` files in cloned repositories to a Solr index running at http://127.0.0.1:8983/solr
 
 ##### Custom Solr location