ferrum_pdf 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd59867787cfd16bf19645eda1dce8c8f21541d3d8b52614e025a60847787930
-  data.tar.gz: 5dd180545309a3a0c61ba90286943404382478c44337495c81237f49953559dd
+  metadata.gz: 0ea0c6aba4254ef7d958dec7d9f51048ce82e106ab068a413c1e3b83ec470b01
+  data.tar.gz: e34df1014f457e4ad42a41a5a29ab9a0d0ab42027cb8d8374aeacf6557a49833
 SHA512:
-  metadata.gz: 4b42648daf392f18fc9f1b8dfa947a1b26a1af29eb615af558dd23440222e80f9d846c40fe44206b1dd9f8bfcad5be64f5987559c6e833a2547b246a97093226
-  data.tar.gz: 649e5d9b57f8bfd4ad9e0c62d23cba3f1b435ec3a7a13a237e8e0cd567914e4958d93489519c103166bed3912327547bfe443af0f8f04697043a05e33658a7ed
+  metadata.gz: 68e840f65f0c0821cb8dfe6f3e249e2b5b567f8d3655c1a71a59f143beb25241aedea29fe33d95b18763a32fd5eea88bec9f6a9f4b0b6181df082544cc2453c2
+  data.tar.gz: 123f094697e37dcee391c157ca5ba379b1b9557e8a4e7c017cb7b45861936bf24e484bec74092793dd3e64e36ffaee0a98bc613f56ed9a5e4e2dfefdbf7f1ac1

data/README.md

@@ -1,28 +1,59 @@
 # FerrumPdf
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+PDFs for Rails using [Ferrum](https://github.com/rubycdp/ferrum) & headless Chrome
 
 ## Installation
-Add this line to your application's Gemfile:
+
+Run the following or add the gem to your Gemfile:
+
+```ruby
+bundle add "ferrum_pdf"
+```
+
+## Usage
+
+### Rails controllers
+
+Use the `render_pdf` helper in Rails controllers to render a PDF from the current action.
+
+```ruby
+def show
+  respond_to do |format|
+    format.html
+    format.pdf { send_data render_pdf, disposition: :inline, filename: "example.pdf" }
+  end
+end
+```
+
+You can also customize which template is rendered:
 
 ```ruby
-gem "ferrum_pdf"
+render_pdf(name = action_name, formats: [ :html ])
 ```
 
-And then execute:
-```bash
-$ bundle
+This will render the template to string, then pass it along to FerrumPdf.
+
+### Directly with HTML
+
+FerrumPdf can generate a PDF from HTML directly:
+
+```ruby
+FerrumPdf.render_pdf(html: content)
 ```
 
-Or install it yourself as:
-```bash
-$ gem install ferrum_pdf
+You can also pass host and protocol to convert any relative paths to full URLs. This is helpful for converting relative asset paths to full URLs.
+
+```ruby
+FerrumPdf.render_pdf(
+  html: content,
+  host: request.host_with_port,
+  protocol: request.protocol
+)
 ```
 
 ## Contributing
-Contribution directions go here.
+
+If you have an issue you'd like to submit, please do so using the issue tracker in GitHub. In order for us to help you in the best way possible, please be as detailed as you can.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ferrum_pdf/version.rb

@@ -1,3 +1,3 @@
 module FerrumPdf
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ferrum_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Oliver
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.2.1
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.2.1
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: ferrum
   requirement: !ruby/object:Gem::Requirement