docs: update usage example

oldvis · Sep 12, 2023 · 799c42c · 799c42c
1 parent d735d85
commit 799c42c
Show file tree

Hide file tree

Showing 4 changed files with 1,454 additions and 1,140 deletions.
diff --git a/README.md b/README.md
@@ -18,6 +18,17 @@ A collection of utility functions to process the query returns from the query fu
 pip install libprocess
 ```
 
+## Usage Example
+
+Query and process metadata in [David Rumsey Map Collection](https://www.davidrumsey.com/):
+
+```python
+from libprocess import DavidRumseyMapCollection
+querier = DavidRumseyMapCollection("./metadata/", "./imgs/")
+querier.fetch_metadata(["https://www.davidrumsey.com/luna/servlet/as/search?q=type=chart"])
+querier.process_metadata(save_path="processedMetadata.json")
+```
+
 ## Documentation
 
 See our [documentation website](https://oldvis.github.io/libprocess/).
diff --git a/docs/guide/get-started.md b/docs/guide/get-started.md
@@ -23,7 +23,7 @@ querier.fetch_metadata(
         "https://www.davidrumsey.com/luna/servlet/as/search?q=type=chart",
     ]
 )
-querier.process_metadata(path="processedMetadata.json", img_dir=None)
+querier.process_metadata(save_path="processedMetadata.json")
 ```
 
 More examples can be found in the API Reference.