Version 3.3.3 (#125)

* Improve readme * Update CHANGELOG.md --------- Co-authored-by: Roman Sedykh <[email protected]>
uploadcare · Mar 27, 2023 · 428a7e6 · 428a7e6
1 parent ba3a9c1
commit 428a7e6
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 9 deletions.
diff --git a/.yardopts b/.yardopts
@@ -2,4 +2,7 @@
 --title 'Uploadcare Rails API Documentation'
 --charset utf-8
 --markup markdown
-'lib/**/*.rb' - '*.md'
+-
+CHANGELOG.md
+LICENSE.txt
+v2.x-migrations-guide.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based now on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 3.3.3 — 2023-03-27
+
+### Changed
+
+* Improved readme to look better at ruby-doc
+
 ## 3.3.2.1 — 2023-03-26
 
 ### Changed
@@ -19,20 +25,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## 3.3.1 — 2023-03-20
 
-* Update gem description
+### Changed
+
+* Updated gem description
 * Respect data-multiple in helper options (https://github.com/uploadcare/uploadcare-rails/issues/119)
 
 ## 3.3.0 — 2023-03-16
 
-Guarantee support of maintainable versions of Ruby and Rails
+Guarantee support of maintainable versions of Ruby and Rails.
 
 ### Breaking Сhanges
 
-Drop support of unmaintainable Ruby 2.4, 2.5, 2.6 and Rails before 6.0
+Drop support of unmaintainable Ruby 2.4, 2.5, 2.6 and Rails before 6.0.
 
 ### Added
 
-Add support of Ruby 3.1 and 3.2 and Rails 7.0
+Add support of Ruby 3.1 and 3.2 and Rails 7.0.
 
 ## 3.0.0 — 2022-12-29
 

diff --git a/README.md b/README.md
@@ -9,7 +9,9 @@
 A Ruby on Rails plugin for [Uploadcare](https://uploadcare.com) service.
 Based on [uploadcare-ruby](https://github.com/uploadcare/uploadcare-ruby) gem (general purpose wrapper for Uploadcare API)
 
-### :heavy_exclamation_mark: *Note: the gem uploadcare-rails 2.x is not backward compatible with 1.x.*
+:heavy_exclamation_mark: *Note: the gem uploadcare-rails 2.x is not backward compatible with 1.x.*
+
+## Table of Contents
 
 * [Requirements](#requirements)
 * [Installation](#installation)
@@ -144,7 +146,7 @@ Full list of available options is listed in the file itself. Just uncomment an o
 The fastest way to start using file uploading is to add the Uploadcare widget to the html-page.
 There is a view helper that can do it with two strings of code:
 
-Add this string to your <head> html-tag
+Add this string to your `<head>` html-tag
 
 ```erb
 <!DOCTYPE html>
@@ -175,7 +177,7 @@ This helper uses a CDN-url for the widget bundle and supports three options:
                More info about bundles [here](https://uploadcare.com/docs/uploads/file-uploader/#bundles).
 - **min** — bool value detecting if the bundle must be minified.
 
-The <head> tag then also includes the <script> with widget global settings set in `config/initializers/uploadcare.rb`. You can override them later in an individual widget.
+The `<head>` tag then also includes the `<script>` with widget global settings set in `config/initializers/uploadcare.rb`. You can override them later in an individual widget.
 
 
 #### Using asset pipeline.

diff --git a/lib/uploadcare/rails/version.rb b/lib/uploadcare/rails/version.rb
@@ -2,6 +2,6 @@
 
 module Uploadcare
   module Rails
-    VERSION = '3.3.2.1'
+    VERSION = '3.3.3'
   end
 end