diff --git a/README.md b/README.md index 64e86c1..288c49d 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,52 @@ You will need the `Robot` and `Source Sans Pro` fonts installed on your system o - [Roboto](https://fonts.google.com/specimen/Roboto) - [Source Sans Pro](https://github.com/adobe-fonts/source-sans-pro) +This template also uses FontAwesome icons via the `[fontawesome](https://typst.app/universe/package/fontawesome)` package. + See `typst fonts --help` for more information on configuring fonts for `typst` that are not installed on your system. ### Usage -:construction: +Below is a basic example for a simple resume: + +```typst +#import "@preview/modern-cv:0.1.0": * + +#show: resume.with( + author: ( + firstname: "John", + lastname: "Smith", + email: "js@example.com", + phone: "(+1) 111-111-1111", + github: "DeveloperPaul123", + linkedin: "Example", + address: "111 Example St. Example City, EX 11111", + positions: ( + "Software Engineer", + "Software Architect" + ) + ), + date: datetime.today().display() +) + += Education + +#resume_entry( + title: "Example University", + location: "B.S. in Computer Science", + date: "August 2014 - May 2019", + description: "Example" +) + +#resume_item[ + - #lorem(20) + - #lorem(15) + - #lorem(25) +] +``` + +### Output + +| | | +| --- | --- | +| ![Resume](resume.png) | ![Coverletter](coverletter.png) | \ No newline at end of file diff --git a/coverletter.png b/coverletter.png new file mode 100644 index 0000000..2ca5621 Binary files /dev/null and b/coverletter.png differ