README.md in convert_api-2.0.0 vs README.md in convert_api-3.0.0
- old
+ new
@@ -21,27 +21,18 @@
## Usage
### Configuration
-You can get your secret at https://www.convertapi.com/a/auth
+You can get your credentials at https://www.convertapi.com/a/auth
```ruby
ConvertApi.configure do |config|
- config.api_secret = 'your-api-secret'
+ config.api_credentials = 'your-api-secret-or-token'
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
[here](https://www.convertapi.com/doc/supported-formats).
@@ -106,11 +97,11 @@
puts result.files[0].size
```
### User information
-You can always check your remaining seconds programmatically by fetching [user information](https://www.convertapi.com/doc/user).
+You can always check your usage by fetching [user information](https://www.convertapi.com/doc/user).
```ruby
user_info = ConvertApi.user
puts user_info['ConversionsConsumed']
@@ -133,13 +124,9 @@
## 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