Skip to content

Commit 2e6ee5a

Browse files
committed
fix: clarify readme instructions
1 parent 7af857d commit 2e6ee5a

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,16 @@ For MAC:
5353
Linux:
5454
`sudo apt-get install imagemagick`
5555

56-
You can convert a directory of PNG images associated with a
57-
blog post that you write using:
56+
You can convert a directory of `.png` images associated with a
57+
blog post that you write using the following bash command:
5858

5959
`for file in *.png; do cwebp "$file" -o "${file%.*}.webp"; done`
6060

61-
or a single image
61+
or you can convert a single image:
6262

6363
`cwebp input-image.png -o output-image.webp`
6464

65-
Below is an example of adding a figure to a post that has both webp and .png formats to support older and newer browsers.
65+
Below is an example of how to add figure to a post that supports both `.webp` and `.png` formats. Providing both allows the website to be backwards-compatible with older browsers.
6666

6767
```html
6868
<figure>
@@ -74,10 +74,12 @@ Below is an example of adding a figure to a post that has both webp and .png for
7474
```
7575
## How to update blog post last_updated field
7676

77-
We have a script that will automatically update the last_updated field for all of our blog posts. To run it use:
77+
We have a bash script that will automatically update the `last_updated` field in the YAML for all of our blog posts. To run it use:
7878

7979
`./scripts/date-updated.sh`
8080

81+
Note: it would be nice to add this into our CI build but right now we do not have that setup. So we just need to run this script periodically to update the `last_updated` field when we update a blog post.
82+
8183
## Contributors ✨
8284

8385
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

0 commit comments

Comments
 (0)