Skip to content

Commit

Permalink
chore: prepare for initial publish
Browse files Browse the repository at this point in the history
  • Loading branch information
EdRW committed Aug 14, 2024
1 parent 1e045a9 commit 9e05ff3
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 17 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,30 @@
# jsonresume-theme-pico

A minimal theme for [JSON Resume](https://jsonresume.org/) using [PicoCSS](https://picocss.com/). Built with PDF printing and mobile devices in mind.
A minimal theme for [JSON Resume](https://jsonresume.org/) using [PicoCSS](https://picocss.com/). Built with PDF printing, dark/light theme, and mobile devices in mind.

See a live example at [https://edrw.dev/resume](https://edrw.dev/resume).

## Features
## Installation

npm

```bash
npm install jsonresume-theme-pico
```

pnpm

```bash
pnpm add jsonresume-theme-pico
```

yarn

```bash
yarn add jsonresume-theme-pico
```

## Screenshots

### Dark Theme

Expand All @@ -17,3 +37,8 @@ See a live example at [https://edrw.dev/resume](https://edrw.dev/resume).
### Responsive

![responsive example](examples/mobile-example.png)

## Credits

- The theme design is inspired by [jsonresume-theme-caffeine](https://github.com/kelyvin/jsonresume-theme-caffeine).
- Icons are from [Simple Icons](https://simpleicons.org/) and [Iconify](https://iconify.design/).
38 changes: 23 additions & 15 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
{
"name": "jsonresume-theme-pico",
"version": "0.0.1",
"description": "A minimal theme for JSON Resume using PicoCSS. Built with PDF printing in mind.",
"description": "A minimal theme for JSON Resume using PicoCSS. Built with PDF printing and mobile devices in mind.",
"author": "Edmund Rosewright",
"license": "MIT",
"scripts": {
"start": "nodemon --exec 'pnpm render'",
"render": "resumed render resume.json --theme jsonresume-theme-pico",
"export": "node scripts/export-pdf.js",
"test": "resumed validate resume.json"
},
"nodemonConfig": {
"ext": "js,hbs,json,css",
"ignore": [
"resume.html",
"resume.pdf"
]
"repository": {
"type": "git",
"url": "git+https://github.com/EdRW/jsonresume-theme-pico.git"
},
"homepage": "https://github.com/EdRW/jsonresume-theme-pico",
"bugs": {
"url": "https://github.com/EdRW/jsonresume-theme-pico/issues"
},
"engines": {
"node": ">=20.14.0"
Expand All @@ -23,27 +25,26 @@
"keywords": [
"basic",
"json",
"json-resume",
"jsonresume",
"jsonresume-theme",
"resume",
"theme",
"pico",
"picocss",
"pico.css",
"print",
"pdf"
"pdf",
"dark",
"mobile",
"responsive"
],
"license": "MIT",
"author": "Edmund Rosewright",
"files": [
"index.js",
"resume.hbs",
"style.css",
"theme"
],
"repository": {
"type": "git",
"url": "https://github.com/edrw/jsonresume-theme-pico"
},
"dependencies": {
"handlebars": "^4.7.8",
"moment": "^2.30.1",
Expand All @@ -54,5 +55,12 @@
"nodemon": "^3.1.4",
"puppeteer": "^22.13.1",
"resumed": "^3.0.1"
},
"nodemonConfig": {
"ext": "js,hbs,json,css",
"ignore": [
"resume.html",
"resume.pdf"
]
}
}

0 comments on commit 9e05ff3

Please sign in to comment.