Merge pull request #3 from brock/document-unit-system-options

add documentation for unit system options to README
usnistgov · Aug 27, 2015 · f5f88c3 · f5f88c3
2 parents bafd4b2 + 334503a
commit f5f88c3
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -23,6 +23,16 @@ viewer.scalebar({
 });
 `````
 
+To change the Unit system from the defualt of Metric to Imperial, you must reference the `sizeAndTextRenderer` function in the library directly:
+
+`````javascript
+viewer.scalebar({
+  ...
+  sizeAndTextRenderer: OpenSeadragon.ScalebarSizeAndTextRenderer.IMPERIAL_LENGTH,
+  ...
+});
+`````
+
 The list of all the options can be found and tested on http://nist-isg.github.io/OpenSeadragonScalebar/
 If type, pixelsPerMeter or location are not set (or set to 0), the bar is hidden.