@jlengstorf/get-share-image - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

package.json

 {
   "name": "@jlengstorf/get-share-image",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "main": "index.js",
@@ -5,0 +5,0 @@ "author": "Jason Lengstorf <[e-mail]> (https://lengstorf.com)",

README.md

@@ -7,2 +7,6 @@ # Generate Social Media Images Using Cloudinary
 
+**This was created as part of an article series:**
+- [How to design a social sharing card template](https://www.learnwithjason.dev/blog/design-social-sharing-card/)
+- [How the code in this package works](https://www.learnwithjason.dev/blog/auto-generate-social-image/)
+
 ## Installation
@@ -18,2 +22,4 @@
 
+See how this is used in a production site in the [learnwithjason.dev source code](https://github.com/jlengstorf/learnwithjason.dev/blob/070468828e8c758d150a8d573fd471d786278243/packages/%40jlengstorf/gatsby-theme-code-blog/src/gatsby-theme-blog-core/components/post.js#L55-L64).
+
 ## Example Usage
@@ -48,21 +54,23 @@
 
-| name              | required | description                                                          |
-| ----------------- | -------- | -------------------------------------------------------------------- |
-| title             | true     | (string) title text to be placed on the card                         |
-| tagline           | true     | (string) tagline text to be placed on the card                       |
-| cloudName         | true     | (string) your Cloudinary cloud name (i.e. your username)             |
-| imagePublicID     | true     | (string) the public ID of your social image template                 |
-| cloudinaryUrlBase |          | (string, default `https://res.cloudinary.com`) Cloudinary asset URL  |
-| titleFont         |          | (string, default `arial`) font to use for rendering title            |
-| taglineFont       |          | (string, default `arial`) font to use for rendering tagline          |
-| imageWidth        |          | (number, default `1280`) SEO image width (defaults to Twitter ratio) |
-| imageHeight       |          | (number, default `669`) SEO image height (defaults to Twitter ratio) |
-| textAreaWidth     |          | (number, default `760`) width of title and tagline text areas        |
-| textLeftOffset    |          | (number, default `480`) distance from left edge to start text boxes  |
-| titleBottomOffset |          | (number, default `254`) distance from bottom to start title text     |
-| taglineTopOffset  |          | (number, default `445`) distance from top to start tagline text      |
-| textColor         |          | (string, default `000000`) hex value for text color                  |
-| titleFontSize     |          | (number, default `64`) font size to use for the title                |
-| taglineFontSize   |          | (number, default `48`) font size to use for the tagline              |
-| version           |          | (string) optional version string for caching                         |
+| name               | required | description                                                          |
+| ------------------ | -------- | -------------------------------------------------------------------- |
+| title              | true     | (string) title text to be placed on the card                         |
+| tagline            | true     | (string) tagline text to be placed on the card                       |
+| cloudName          | true     | (string) your Cloudinary cloud name (i.e. your username)             |
+| imagePublicID      | true     | (string) the public ID of your social image template                 |
+| cloudinaryUrlBase  |          | (string, default `https://res.cloudinary.com`) Cloudinary asset URL  |
+| titleFont          |          | (string, default `arial`) font to use for rendering title            |
+| titleExtraConfig   |          | (string) optional additional text overlay config                     |
+| taglineExtraConfig |          | (string) optional additional text overlay config                     |
+| taglineFont        |          | (string, default `arial`) font to use for rendering tagline          |
+| imageWidth         |          | (number, default `1280`) SEO image width (defaults to Twitter ratio) |
+| imageHeight        |          | (number, default `669`) SEO image height (defaults to Twitter ratio) |
+| textAreaWidth      |          | (number, default `760`) width of title and tagline text areas        |
+| textLeftOffset     |          | (number, default `480`) distance from left edge to start text boxes  |
+| titleBottomOffset  |          | (number, default `254`) distance from bottom to start title text     |
+| taglineTopOffset   |          | (number, default `445`) distance from top to start tagline text      |
+| textColor          |          | (string, default `000000`) hex value for text color                  |
+| titleFontSize      |          | (number, default `64`) font size to use for the title                |
+| taglineFontSize    |          | (number, default `48`) font size to use for the tagline              |
+| version            |          | (string) optional version string for caching                         |
 
@@ -69,0 +77,0 @@ ### Setting config options

No alert changes

Improved metrics

Total package byte prevSize

10349

increased by8.14%

Number of lines in readme file

85

increased by10.39%

No dependency changes