Skip to content

Commit d47eab5

Browse files
committed
docs: update README to include pnpm commands and documentation on how JSON data is handled.
1 parent 67a6352 commit d47eab5

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# personal-portfolio
1+
# My Personal Portfolio - sammyharper.com
22

33
## Description
44

@@ -11,14 +11,19 @@ Website is built using Eleventy (11ty), Nunjucks is used for templating markup.
1111

1212
Below are some more involved sections/aspects of this website (things that maybe aren't as self-explanatory).
1313

14-
### Portfolio generation
14+
For general purposes, build and watch the project using the following commands:
1515

16-
To better handle sorting/filtering and to allow for easier management, portfolio items are generated from **JSON**. The JSON file outlines an item's title, description, image source, and link (if applicable). Some styles require generating HTML each time, meaning that an easier show/hide toggle approach wouldn't work (as built in previous portfolio versions).
16+
```
17+
pnpm run build
18+
```
1719

18-
Then, on page load, `build-projects-scripts.js` generates sections for each JSON item.
20+
```
21+
pnpm run start
22+
```
1923

20-
**NOTE:** This will eventually be converted to utilizing the 11ty build process to handle JSON data/item generation.
24+
### Portfolio generation
2125

26+
To better handle sorting/filtering and to allow for easier management, portfolio items are generated from **JSON**. The JSON file outlines an item's title, description, image source, and link (if applicable).
2227

2328
### `/now` page
2429

@@ -27,4 +32,4 @@ For easier management/updating, the items on the `/now` page are generated from
2732

2833
## Contributions
2934

30-
As this is a personal portfolio, only small contributions will be accepted and merged into main. Thank you for your interest in contributing, but this project is demonstrative of past projects AND my own abilities to build the portfolio itself. Feedback will be happily accepted through Issues, social media, or email.
35+
As this is a personal portfolio, only small contributions will be accepted and merged into main. Thank you for your interest in contributing, but this project is demonstrative of past projects AND my own abilities to build the portfolio itself. Feedback will be happily accepted through Issues, social media, or email.

0 commit comments

Comments
 (0)