README.md in form_api-0.1.0 vs README.md in form_api-0.1.1
- old
+ new
@@ -3,12 +3,16 @@
This is a Ruby gem for using [FormAPI](https://formapi.io) to generate PDF documents from configured templates.
## Installation
-Add the following to your `Gemfile`.
+```bash
+gem install form_api
+```
+Or add the following to your `Gemfile`.
+
```ruby
gem "form_api"
```
Then run:
@@ -18,43 +22,45 @@
```
## Usage
-See [examples](examples/) for runnable examples with file output, error handling, etc.
+See [examples](examples/) for runnable examples.
```ruby
FormAPI.configure do |config|
- config.username = "YOUR_API_KEY_HERE"
- # config.debugging = true
+ config.username = "YOUR_API_TOKEN_ID"
+ config.password = "YOUR_API_TOKEN_SECRET"
end
formapi = FormAPI::Client.new
response = formapi.generate_pdf(
- template_id: '<TEMPLATE_ID>', # ID of a template that you have configured
- test: true, # Test documents are free but watermarked
- template_data: { # Data to fill in the template
+ template_id: '<TEMPLATE_ID>', # ID of a template that you have configured
+ test: true, # Test documents are free but watermarked
+ template_data: { # Data to fill in the template
name: "foo",
number: 42
- },
- key: "<CUSTOM_KEY>", # Helps you find a PDF later
+ }
)
+
+
```
This submits a PDF request and waits for the job to finish.
## More Help
-See the FormAPI documentation for more information.
+See the [FormAPI documentation](https://formapi.io/docs) for more information.
-Please [email us](mailto:support@formapi.io) if you need help.
+Please [email us](mailto:support@formapi.io) if you need any help.
## Development
-The majority of the code in this repo is generated using swagger-codegen on [formapi.yaml](formapi.yaml). You can modify this file and regenerate the client using `script/generate_language ruby`.
+The majority of the code in this repo is generated using swagger-codegen.
+You can modify this file and regenerate the client using `scripts/generate`.
## Release Process
1. Pull latest master