Skip to content

Commit d1760a3

Browse files
committed
fix(docs): update README to enhance documentation for Ruby on Rails integration and remove outdated sections
1 parent c427415 commit d1760a3

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22

33
The ImageKit Ruby library provides convenient access to the ImageKit REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/imagekit-developer/imagekit-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
44

5+
## Documentation
6+
7+
- **Official ImageKit Ruby Documentation**: [https://imagekit.io/docs/integration/ruby](https://imagekit.io/docs/integration/ruby)
8+
- **REST API Documentation**: [https://imagekit.io/docs/api-reference](https://imagekit.io/docs/api-reference)
9+
- **Gem Documentation (RubyDoc)**: [https://gemdocs.org/gems/imagekitio](https://gemdocs.org/gems/imagekitio)
10+
11+
### Ruby on Rails Integration
12+
13+
If you're using Ruby on Rails, ImageKit can be easily integrated with popular file upload libraries:
14+
15+
- **Active Storage**: Learn how to integrate ImageKit with Rails Active Storage for seamless file uploads and transformations. See the [Active Storage integration guide](https://imagekit.io/docs/integration/ruby/ruby-on-rails-with-active-storage).
16+
17+
- **CarrierWave**: Integrate ImageKit with CarrierWave for powerful file upload handling in your Rails applications. See the [CarrierWave integration guide](https://imagekit.io/docs/integration/ruby/ruby-on-rails-with-carrierwave).
18+
519
## Table of Contents
620

721
- [Documentation](#documentation)
@@ -32,12 +46,6 @@ The ImageKit Ruby library provides convenient access to the ImageKit REST API fr
3246
- [Requirements](#requirements)
3347
- [Contributing](#contributing)
3448

35-
## Documentation
36-
37-
Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/imagekitio).
38-
39-
The REST API documentation can be found on [imagekit.io](https://imagekit.io/docs/api-reference).
40-
4149
## Installation
4250

4351
To use this gem, install via Bundler by adding the following to your application's `Gemfile`:

0 commit comments

Comments
 (0)