@canopycanopycanopy/b-ber-resources 3.0.8-nav.0 → 3.0.8-next.61

package/README.md

@@ -1,9 +1,19 @@
-# `@canopycanopycanopy/b-ber-resources`
+# b-ber-resources
 
-The `b-ber-resources` package contains assets for newly initialized b-ber projects.
+Provides static image assets used by b-ber builds as fallback or default resources. During a build, the main export reads its own directory and returns a map of `{ baseName: absoluteFilePath }` for every PNG or JPEG file it finds. Consumers use this map to locate assets (e.g. a default publisher logo) without hard-coding paths.
 
-## Install
+## Contents
 
-```
-$ npm i -g @canopycanopycanopy/b-ber-resources
+| Path                          | Purpose                                                           |
+| ----------------------------- | ----------------------------------------------------------------- |
+| `b-ber-logo.png`              | b-ber project logo                                                |
+| `default-publishers-logo.png` | Fallback publisher logo used when a project has no custom logo    |
+| `src/index.js`                | Source: reads the package directory and returns an asset path map |
+| `index.js`                    | Built output of `src/index.js` (generated by `npm run build`)     |
+
+## Dev
+
+```bash
+npm test       # runs jest (test suite currently contains only a placeholder todo)
+npm run build  # transpiles src/ to index.js via Babel
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-resources",
-  "version": "3.0.8-nav.0+24db1e6b",
+  "version": "3.0.8-next.61+2bbec564",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -46,5 +46,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "24db1e6bb491faae0d52c6dadc09d974a5a31cf5"
+  "gitHead": "2bbec5643278f53becb0d2ba1f55edfe379d5587"
 }