update version

chrismwilliams · Jul 4, 2023 · 01f7662 · 01f7662
1 parent 4616144
commit 01f7662
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -71,11 +71,12 @@ Adding a post is a simple as adding your .md(x) file(s) to the `src/content/post
 ### Frontmatter
 
 | Property (\* required) | Description                                                                                                                                                                                                                                                                                       |
-| :--------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | title \*               | Self explanatory. Used as the text link to the post, the h1 on the posts' page, and the pages title property. Has a max length of 60 chars, set in `src/content/config.ts`                                                                                                                        |
 | description \*         | Similar to above, used as the seo description property. Has a min length of 50 and a max length of 160 chars, set in the post schema.                                                                                                                                                             |
 | publishDate \*         | Again pretty simple. To change the date format/locale, currently **en-GB**, update/pass the **locale** arg to function **getFormattedDate**, found in `src/utils/date.ts`.                                                                                                                        |
 | tags                   | Tags are optional with any created post. Any new tag(s) will be shown in `yourdomain.com/posts` + `yourdomain.com/tags`, and generate the page(s) `yourdomain.com/tags/[yourTag]`                                                                                                                 |
+| coverImage             | This is an optional object that will add a cover image to the top of a post. Include both a `src`: "_path-to-image_" and `alt`: "_image alt_". You can view an example in `src/content/post/cover-image.md`                                                                                       |
 | ogImage                | This is an optional property. An OG Image will be generated automatically for every post where this property **isn't** provided. If you would like to create your own for a specific post, include this property and a link to your image, the theme will then skip automatically generating one. |
 
 ## Analytics
@@ -94,15 +95,15 @@ pnpm install astro-google-analytics
 
 Edit `src/layouts/Base.astro`, and add:
 
-```tsx
+```astro
 ---
-import { GoogleAnalytics } from 'astro-google-analytics';
+import { GoogleAnalytics } from "astro-google-analytics";
 // ...other imports
 ---
 
 <head>
-  <!-- Replace id with your own Google Analytics ID -->
-  <GoogleAnalytics id="G-XXXXXXXXXX" />
+	<!-- Replace id with your own Google Analytics ID -->
+	<GoogleAnalytics id="G-XXXXXXXXXX" />
 </head>
 ```
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "astro-cactus",
-	"version": "2.4.1",
+	"version": "2.5.0",
 	"private": false,
 	"scripts": {
 		"dev": "astro dev",