Skip to content
This repository has been archived by the owner on Dec 19, 2023. It is now read-only.

Commit

Permalink
feat: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
levino committed Apr 28, 2023
1 parent f8717b2 commit 4cab57f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 845 deletions.
9 changes: 5 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ resume.html
resume.pdf
resume.json
.DS_Store
/dist
/public
!/public/profile.jpeg
!/public/style.css
dist/
public/
!public/profile.jpeg
!public/style.css
storybook-static/
74 changes: 4 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,7 @@
# Stack Overflow theme for jsonresume [![npm version](https://badge.fury.io/js/jsonresume-theme-stackoverflow.svg)](http://badge.fury.io/js/jsonresume-theme-stackoverflow)
# Fork of jsonresume-theme-stackoverflow

**Printable version with custom CSS**
I forked this and migrated it all to react. See the [`package.json`](./package.json) for the available scripts. Development should be done via the storybook.

[DEMO](https://francesco.netlify.app/)
## Storybook deployment

## Getting started

### Install the command line

Create your resume in json on [jsonresume](https://jsonresume.org)

The official [resume-cli](https://github.com/jsonresume/resume-cli) to run the development server.

Go ahead and install it:

```
npm install -g resume-cli
```

### Install and serve theme

Clone the repository

```
git clone https://github.com/francescoes/jsonresume-theme-stackoverflow.git
```

Create a 'resume.json' file in the current folder and follow the [json resume schema](https://jsonresume.org/schema/)

Simply run:

```
resume serve --theme .
```

### Social Profiles Icons

**Profiles supported with brand colors:**

Please note that all the [Font awesome brands icons](https://fontawesome.com/search?s=brands) are supported. Although only the ones listed below have a color code associated with it in my CSS file:

github, stack-overflow, linkedin, dribbble, twitter, facebook, pinterest, instagram, soundcloud, wordpress, youtube, flickr, google plus, tumblr, foursquare.

To have a social icon close the social link profile (or username) it is enough to set a `network` the name of the Social Network (es: 'Stack Overflow'). I am replacing spaces with dashes (`-`) and transforming all the network name to all lowercase to match the Font awesome naming convention for brands icons.

#### Support to extra fields

With stackoverflow theme it is possible to add:

- `keywords` to each 'work', 'publication' and 'volunteer' item
- `summary` to each 'interests' and 'education' item
- `birth` to 'basics' (might be commonly used in Europe)

example of the extra `birth` object:

```
"birth": {
"place": "New York",
"state": "USA",
"date": "1988"
}
```

## Contribution

Fork the project, add your feature (or fix your bug) and open a pull request OR

[Open an issue](https://github.com/francescoes/jsonresume-theme-stackoverflow/issues/new) if you find find or if you would like to have extra fields or changes

## License

Available under the [MIT license](http://opensource.org/licenses/mit-license.php).
There is an automatic storybook [deployment](https://sb-stackoverflow-jsonresume-theme.netlify.app/).
Loading

0 comments on commit 4cab57f

Please sign in to comment.