From 13027d9fe6788ea469e6cf6e21a1440c1f889d84 Mon Sep 17 00:00:00 2001 From: Mog Nesbitt Date: Sun, 28 Jan 2024 14:36:25 +1300 Subject: [PATCH] Reformat readme and fix minimum Ruby version --- README.md | 44 ++++++++++++++++++++++++-------------------- 1 file changed, 24 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index d902013..7de1754 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This will take an SVG document as input and render it into your PDF. Find out m http://github.com/prawnpdf/prawn prawn-svg is compatible with all versions of Prawn from 0.11.1 onwards, including the 1.x and 2.x series. -The minimum Ruby version required is 2.3.0. +The minimum Ruby version required is 2.5.0. ## Using prawn-svg @@ -33,7 +33,7 @@ Option | Data type | Description :enable_web_requests | boolean | If true, prawn-svg will make http and https requests to fetch images. Defaults to true. :enable_file_requests_with_root | string | If not nil, prawn-svg will serve `file:` URLs from your local disk if the file is located under the specified directory. It is very dangerous to specify the root path ("/") if you're not fully in control of your input SVG. Defaults to `nil` (off). :cache_images | boolean | If true, prawn-svg will cache the result of all URL requests. Defaults to false. -:fallback_font_name | string | A font name which will override the default fallback font of Times-Roman. If this value is set to nil, prawn-svg will ignore a request for an unknown font and log a warning. +:fallback_font_name | string | A font name which will override the default fallback font of Times-Roman. If this value is set to `nil`, prawn-svg will ignore a request for an unknown font and log a warning. :color_mode | :rgb, :cmyk | Output color mode. Defaults to :rgb. ## Examples @@ -54,31 +54,33 @@ Option | Data type | Description prawn-svg supports most but not all of the full SVG 1.1 specification. It currently supports: - - <line>, <polyline>, <polygon>, <circle> and <ellipse> + - ``, ``, ``, `` and `` - - <rect>. Rounded rects are supported, but only one radius is applied to all corners. + - ``. Rounded rects are supported, but only one radius is applied to all corners. - - <path> supports all commands defined in SVG 1.1, although the + - `` supports all commands defined in SVG 1.1, although the implementation of elliptical arc is a bit rough at the moment. - - ``, `` and `` with attributes `x`, `y`, `dx`, `dy`, `rotate`, 'textLength', 'lengthAdjust', and with extra properties - `text-anchor`, `text-decoration` (underline only), `font-size`, `font-family`, `font-weight`, `font-style`, `letter-spacing`, `dominant-baseline` (middle only) + - ``, `` and `` with attributes `x`, `y`, `dx`, `dy`, `rotate`, 'textLength', 'lengthAdjust', + and with extra properties `text-anchor`, `text-decoration` (underline only), `font-size`, `font-family`, + `font-weight`, `font-style`, `letter-spacing`, `dominant-baseline` (middle only) - - <svg>, <g> and <symbol> + - ``, `` and `` - - <use> + - `` - - <style> (see CSS section below) + - `