README.md in convert_api-1.4.0 vs README.md in convert_api-2.0.0
- old
+ new
@@ -21,21 +21,30 @@
## Usage
### Configuration
-You can get your secret at https://www.convertapi.com/a
+You can get your secret at https://www.convertapi.com/a/auth
```ruby
ConvertApi.configure do |config|
config.api_secret = 'your-api-secret'
end
```
+Or
+
+You can get your token at https://www.convertapi.com/a/access-tokens
+```ruby
+ConvertApi.configure do |config|
+ config.token = 'your-token'
+end
+```
+
### File conversion
-Example to convert file to PDF. All supported formats and options can be found
+Example to convert file to PDF. All supported formats and options can be found
[here](https://www.convertapi.com/doc/supported-formats).
```ruby
result = ConvertApi.convert('pdf', { File: '/path/to/my_file.docx' })
@@ -102,11 +111,11 @@
You can always check your remaining seconds programmatically by fetching [user information](https://www.convertapi.com/doc/user).
```ruby
user_info = ConvertApi.user
-puts user_info['SecondsLeft']
+puts user_info['ConversionsConsumed']
```
### Alternative domain
Set config `base_uri` attribute to use other service domains. Dedicated to the region [domain list](https://www.convertapi.com/doc/servers-location).
@@ -124,9 +133,13 @@
## Development
Run `CONVERT_API_SECRET=your_secret rake spec` to run the tests.
+
+Or
+
+Run `CONVERT_API_TOKEN=your_token rake spec` to run the tests.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing