Document portfolio section

1 files changed, 29 insertions, 5 deletions

diff --git a/README.md b/README.md
index 945d5c6..c211f5c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
 ![GitHub](https://img.shields.io/github/license/samrobbins85/hugo-developer-portfolio?style=for-the-badge)
+
 # Developer Portfolio
 
 ![Website Image](https://res.cloudinary.com/samrobbins/image/upload/v1591885280/screenshot_aexm2m.png)
@@ -183,6 +184,32 @@ skill:
       description: Details coming soon, contact me if you want to know more
 ```
 
+#### portfolio
+
+This is used to highlight specific portfolio projects you want to show
+
+- `enable` can be used to hide this section
+- `title` is the text at the top each item
+- `image` is the image for each item
+- `description` goes underneath the image for each item
+- `link` directs to the main portfolio page
+- `tools` indicates what technologies you used, it uses the icons from https://simpleicons.org/
+
+```yml
+portfolio:
+  enable: true
+  item:
+    - title: Easy DMARC
+      image: https://res.cloudinary.com/samrobbins/image/upload/v1597159067/Easy_DMARC_hkcgif.webp
+      description: A website to make it easy to add DMARC to a Vercel website
+      link: "/portfolio/easy-dmarc"
+      tools:
+        - next-dot-js
+        - tailwindcss
+        - vercel
+        - react
+```
+
 #### experience
 
 - `enable` can be used to hide this section
@@ -215,7 +242,6 @@ hackathons:
       url: none
 ```
 
-
 #### certifications
 
 This allows you to list your certifications in the following format
@@ -256,10 +282,8 @@ education:
       image: https://res.cloudinary.com/samrobbins/image/upload/f_auto,q_auto/v1591793268/logos/logos_Durham_fc2sae.svg
 ```
 
-
-
-
 ### `about.yml`
+
 This file configures the about page, and follows the format below:
 
 ```yml
@@ -273,6 +297,7 @@ leadership:
 ```
 
 ### `porfolio.yml`
+
 This file configures the portfolio page, allowing you to specify the filters you want to use.
 
 ```yml
@@ -281,7 +306,6 @@ filter:
     value: web-dev
 ```
 
-
 ### Blogs
 
 When submitting a blog, you can supply the following fields in the front matter