Added documentation for StoreDimensions plugin. Bumped version.

jetrockets · May 25, 2020 · 34986b3 · 34986b3
1 parent 6518bb6
commit 34986b3
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -263,6 +263,35 @@ image.metadata["custom_1"]
 image.metadata["custom_2"]
 ```
 
+### Store Dimensions
+
+The `StoreDimensions` plugin extracts dimensions of uploaded images and stores them into the metadata.
+
+``` crystal
+class Uploader < Shrine
+  load_plugin(Shrine::Plugins::StoreDimensions,
+    analyzer: Shrine::Plugins::StoreDimensions::Tools::BuiltIn)
+
+  finalize_plugins!
+end
+```
+
+``` crystal
+image.metadata["width"]
+image.metadata["height"]
+```
+
+**Analyzers**
+
+The following analyzers are accepted:
+
+| Name            | Description                                                                                                                                                                                                         |
+|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `BuiltIn`         | (**Default**). A built-in solution that wrapps ImageMagick's `identify` command                                                                           |
+| `Pixie`         | Uses the [Pixie](https://github.com/watzon/pixie).
+
+
+
 
 ## Feature Progress
 
@@ -284,7 +313,7 @@ Items not marked as completed may have partial implementations.
     - [X] #stream
     - [X] #replace
     - [X] #delete
-- [ ] Shrine::Attacher
+- [X] Shrine::Attacher
 - [ ] Shrine::Attachment
 - [ ] Shrine::Storage
     - [X] Shrine::Storage::Memory

diff --git a/shard.yml b/shard.yml
@@ -1,5 +1,5 @@
 name: shrine
-version: 0.5.2
+version: 0.5.3
 description: |
   File Attachment toolkit for Crystal applications