diff --git a/README.md b/README.md index a719027..8baba37 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,24 @@ # The resume that builds itself -If you want a good looking resume, look no further. +If you want a good-looking resume, look no further. -Just clone that repo, edit `config.toml` and follow the instructions on this blog post to get a nice looking online resume with automated PDFs. +Just clone that repo, edit [`config.toml`](./config.toml), and follow the instructions on this blog post to get a nice-looking online resume with automated PDFs. -For a detailled breakdown, head over to my [blog post](https://bas.codes/posts/github-actions-resume) +For a detailed breakdown, head over to my [blog post](https://bas.codes/posts/github-actions-resume) Here is what you need: -- An account on netlify (free) +- An account on Netlify (free) - An account on pdf.co (free credits available) -- a domain name +- A domain name ## How it looks -![](screenshot.png) +![Screenshot of the resume generated by the repo](example.png) -[https://resume-demo.bas.work](https://resume-demo.bas.work) +### Live Demo + +[resume-demo.bas.work](https://resume-demo.bas.work) ## Credits @@ -26,4 +28,4 @@ Here is what you need: - [Hugo](https://github.com/gohugoio/hugo) for static site generation - [Netlify](https://netlify.com) for hosting - [PDF.co](https://pdf.co) for PDF generation -- [GitHub Actions](https://github.com/features/actions) for automating the deployment \ No newline at end of file +- [GitHub Actions](https://github.com/features/actions) for automating the deployment diff --git a/screenshot.png b/example.png similarity index 100% rename from screenshot.png rename to example.png