Skip to content

Commit

Permalink
README.md update
Browse files Browse the repository at this point in the history
  • Loading branch information
sinaru committed Nov 25, 2023
1 parent 83a24f8 commit dbf9179
Showing 1 changed file with 4 additions and 8 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
# CvBuilder

*Build a beautiful CV from a text file.*

Uses `wkhtmltopdf` to generate the PDF.

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/cv_builder`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem
*Build a beautiful CV PDF from a yaml text file.*

## Installation

This page `wkhtmltopdf` to generate the PDF. [See here](https://wkhtmltopdf.org/downloads.html) to install it.

Add this line to your application's Gemfile:

```ruby
Expand All @@ -26,7 +22,7 @@ Or install it yourself as:

## Usage

First we need to have a yaml file with the CV data. The yaml file support following sections.
First we need to have a yaml file with the CV data. The yaml file supports following sections.

```yaml
version: 1
Expand Down

0 comments on commit dbf9179

Please sign in to comment.