README.md in fillable-pdf-0.9.4 vs README.md in fillable-pdf-0.9.5

- old
+ new

@@ -1,33 +1,37 @@ # FillablePDF [![Gem Version](https://badge.fury.io/rb/fillable-pdf.svg)](https://rubygems.org/gems/fillable-pdf) -[![Build Status](https://app.travis-ci.com/vkononov/fillable-pdf.svg?branch=master)](http://travis-ci.org/vkononov/fillable-pdf) +[![Test Status](https://github.com/vkononov/fillable-pdf/actions/workflows/test.yml/badge.svg)](https://github.com/vkononov/fillable-pdf/actions) FillablePDF is an extremely simple and lightweight utility that bridges iText and Ruby in order to fill out fillable PDF forms or extract field values from previously filled out PDF forms. ## Known Issues -1. This gem currently does not work with Phusion Passenger's [smart spawning](https://www.phusionpassenger.com/library/indepth/ruby/spawn_methods/#the-smart-spawning-method). Please see [Deployment with Phusion Passenger + Nginx](#deployment-with-phusion-passenger--nginx) for more information. +1. Phusion Passenger's [smart spawning](https://www.phusionpassenger.com/library/indepth/ruby/spawn_methods/#the-smart-spawning-method) is not supported. Please see [Deployment with Phusion Passenger + Nginx](#deployment-with-phusion-passenger--nginx) for more information. -2. If the gem hangs in `development`, removing the following gems may fix the issue: +2. Puma workers (process forking) is not supposed due to an [issue](https://github.com/arton/rjb/issues/88) with the [rjb](https://github.com/arton/rjb) gem dependency. +3. If the gem hangs in `development`, removing the following gems may fix the issue: + ```ruby gem 'spring' gem 'spring-watcher-listen' ``` -3. Read-only, write-protected or encrypted PDF files are currently not supported. +4. Read-only, write-protected or encrypted PDF files are currently not supported. +5. Adobe generated field arrays (i.e. fields with names such as `array.0` or `array.1.0`) are not supported. + ## Installation **Prerequisites:** Java SE Development Kit v8, v11 -- Ensure that your `JAVA_HOME` variable is set before installing this gem (see examples below).** +- Ensure that your `JAVA_HOME` variable is set before installing this gem (see examples below). * OSX: `/Library/Java/JavaVirtualMachines/jdk-11.0.2.jdk/Contents/Home` * Ubuntu/CentOS: `/usr/lib/jvm/java-1.8.0-openjdk` Add this line to your application's Gemfile: @@ -133,20 +137,26 @@ pdf.field(:full_name) # output example: 'Richard' ``` * `field_type` - *Retrieves the numeric type of a field given its unique field name.* + *Retrieves the string type of a field given its unique field name.* ```ruby pdf.field_type(:football) # output example: '/Btn' # list of all field types Field::BUTTON ('/Btn') Field::CHOICE ('/Ch') Field::SIGNATURE ('/Sig') Field::TEXT ('/Tx') + ``` + + You can check the field type by using: + + ```ruby + pdf.field_type(:football) == Field::BUTTON ``` * `fields` *Retrieves a hash of all fields and their values.* \ No newline at end of file