README.md in combine_pdf-1.0.18 vs README.md in combine_pdf-1.0.19
- old
+ new
@@ -1,10 +1,12 @@
# CombinePDF - the ruby way for merging PDF files
[](http://badge.fury.io/rb/combine_pdf)
[](https://github.com/boazsegev/combine_pdf)
+[](https://www.rubydoc.info/github/boazsegev/combine_pdf)
[](https://github.com/pickhardt/maintainers-wanted)
+
CombinePDF is a nifty model, written in pure Ruby, to parse PDF files and combine (merge) them with other PDF files, watermark them or stamp them (all using the PDF file format and pure Ruby code).
## Install
Install with ruby gems:
@@ -112,10 +114,45 @@
pdf = CombinePDF.load "file_to_number.pdf"
pdf.number_pages
pdf.save "file_with_numbering.pdf"
```
-Numbering can be done with many different options, with different formating, with or without a box object, and even with opacity values - see documentation.
+Numbering can be done with many different options, with different formating, with or without a box object, and even with opacity values - [see documentation](https://www.rubydoc.info/github/boazsegev/combine_pdf/CombinePDF/PDF#number_pages-instance_method).
+
+For example, should you prefer to place the page number on the bottom right side of all PDF pages, do:
+
+```ruby
+pdf.number_pages(location: [:bottom_right])
+```
+
+As another example, the dashes around the number are removed and a box is placed around it. The numbering is semi-transparent and the first 3 pages are numbered using letters (a,b,c) rather than numbers:
+
+
+```ruby
+# number first 3 pages as "a", "b", "c"
+pdf.number_pages(number_format: " %s ",
+ location: [:top, :bottom, :top_left, :top_right, :bottom_left, :bottom_right],
+ start_at: "a",
+ page_range: (0..2),
+ box_color: [0.8,0.8,0.8],
+ border_color: [0.4, 0.4, 0.4],
+ border_width: 1,
+ box_radius: 6,
+ opacity: 0.75)
+# number the rest of the pages as 4, 5, ... etc'
+pdf.number_pages(number_format: " %s ",
+ location: [:top, :bottom, :top_left, :top_right, :bottom_left, :bottom_right],
+ start_at: 4,
+ page_range: (3..-1),
+ box_color: [0.8,0.8,0.8],
+ border_color: [0.4, 0.4, 0.4],
+ border_width: 1,
+ box_radius: 6,
+ opacity: 0.75)
+```
+
+ pdf.number_pages(number_format: " %s ", location: :bottom_right, font_size: 44)
+
## Loading and Parsing PDF data
Loading PDF data can be done from file system or directly from the memory.