Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eralpkaraduman authored Oct 10, 2018
1 parent 407ba5f commit a389406
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,14 @@

# Source of Eralp Karaduman's CV

**If you want to have your own, just fork this repo and modify the `index.md`.**

| Website | PDF Version |
|---------------------------- |------------------|
| [eralpkaraduman.github.io/cv] | [latest release] |

[![Build Status](https://travis-ci.org/eralpkaraduman/cv.svg?branch=gh-pages)](https://travis-ci.org/eralpkaraduman/cv)

**If you want to have your own, just fork this repo and modify the `index.md`.**

This is a fairly modified version of
[elipapa's markdown-cv](http://elipapa.github.io/markdown-cv) project.
Which is using [jekyll](https://jekyllrb.com) to host the cv as static site on github.
Expand All @@ -17,7 +19,6 @@ My version simply uses
[sindresorhus's github-markdown-css](https://github.com/sindresorhus/github-markdown-css), the close
replica of github's markdown style. And it is able to aut-generate a PDF version release through travis-ci (if set up)

[![Build Status](https://travis-ci.org/eralpkaraduman/cv.svg?branch=gh-pages)](https://travis-ci.org/eralpkaraduman/cv)

## Features
- Maintain your cv using Markdown
Expand All @@ -26,6 +27,7 @@ replica of github's markdown style. And it is able to aut-generate a PDF version
- Always have one link to your latest CV online for free
- Update it easily on the web _(using github's web editor)_


## Automatic PDF version generation

Also if you set up Travis CI, i configured it up so after every commit, travis will print it to `cv.pdf` then create a release on github. You can always link to the latest release by adding the sufffix `/releases/latest` to repo url.
Expand All @@ -40,6 +42,7 @@ To enable this;
- If everything was right, it will create a release under `/releases` page of your github repo
- Latest release is conveniently always at `/releases/latest`


## Including downlad link to PDF version in the website

I added a feature which automatically adds the latest PDF version download link to the website.
Expand All @@ -63,4 +66,3 @@ this is how you'd get started;

`bundle install`
`bundle exec jekyll serve --host=0.0.0.0`

0 comments on commit a389406

Please sign in to comment.