@ca-plant-list/ca-plant-list 0.4.15 → 0.4.17

package/README.md

@@ -25,3 +25,27 @@ node scripts/build-ebook.js
 
 # ebook is at output/ebplants.epub
 ```
+
+## Usage
+
+```zsh
+npm i --save @ca-plant-list/ca-plant-list
+```
+
+### Customizing Photos
+
+ca-plant-list loads photos of plants from iNat and maintains lists of photos of all the plants it knows about from both licensed iNat taxon photos and licensed iNat observation photos. If you want to customize the photos that appear on your site, you can add a file of iNat photo data to your local setup. This package provides some tools for doing so. For example, if you wanted to use photos from observations from Alameda and Contra Costa Counties, you could do this:
+
+```zsh
+npx inatobsphotos -q "place_id=845,1527"
+```
+
+That will create `data/inatphotos.csv` in your repo, populated by photos from verifiable observations of the taxa in data/taxa.csv from the place IDs identified in the `-q` param. It chooses from the most-faved observations with the "CC BY" or "CC BY-NC" licenses, or the CC0 declaration.
+
+If you want to load from iNat taxon photos instead, you can do
+
+```zsh
+npx inattaxonphotos
+```
+
+The only reason to do that would be to get more recently-updated iNat taxon photos than ca-plant-list knows about.