@ca-plant-list/ca-plant-list 0.4.4 → 0.4.8

package/.prettierrc

@@ -1 +1,3 @@
-{}
+{
+    "tabWidth": 4
+}

package/.vscode/settings.json

@@ -1,12 +1,4 @@
 {
     "editor.formatOnSave": true,
-    "editor.defaultFormatter": "esbenp.prettier-vscode",
-    "prettier.tabWidth": 4,
-    "json.schemas": [
-        {
-            "fileMatch": ["**/exceptions.json"],
-            "url": "./schemas/exceptions.schema.json"
-        }
-    ],
-    "editor.tabSize": 2
+    "eslint.validate": ["javascript", "typescript"]
 }

package/README.md

@@ -1 +1,27 @@
-This module contains tools for producing Jekyll files to create a set of static HTML pages with information about plants growing in the wild in areas of California.
+# ca-plant-list
+
+This module contains tools and data for producing Jekyll files to create a set of static HTML pages with information about plants growing in the wild in areas of California.
+
+While this is primarily meant as a dependency for other projects building static sites of CA plants, the default config will let you build a site:
+
+```zsh
+# Install Ruby dependencies
+bundle
+
+# Install node dependencies
+npm install
+
+# Build the site
+node scripts/build-site.js
+
+# Start a web server
+bundle exec jekyll serve --config output/_config.yml -s output
+```
+
+You can even build an ebook!
+
+```zsh
+node scripts/build-ebook.js
+
+# ebook is at output/ebplants.epub
+```

package/data/config.json

@@ -12,5 +12,10 @@
         "introduced": "Introduced to the East Bay",
         "native": "Native to the East Bay",
         "status-NC": "California native introduced to the East Bay"
+    },
+    "ebook": {
+        "filename": "ebplants",
+        "pub_id": "ebplants",
+        "title": "East Bay Plants"
     }
 }