From 1cf28cc448d85837ad1e96eaade024a5f3f77970 Mon Sep 17 00:00:00 2001 From: Alexandre Rousseau Date: Tue, 4 Dec 2018 12:55:05 +0100 Subject: [PATCH] Improve description --- README.md | 34 ++++++++++++++++----------------- active_storage-send_zip.gemspec | 2 +- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index af4b52c..c71b68d 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,7 @@ [![Gem Version](https://badge.fury.io/rb/active_storage-send_zip.svg)](https://badge.fury.io/rb/active_storage-send_zip) [![MIT Licence](https://badges.frapsoft.com/os/mit/mit.png?v=103)](https://opensource.org/licenses/mit-license.php) -Create a zip from one or more Active Storage objects and return it in a rails controller - -## Installation - -Add this line to your application's Gemfile: - -```ruby -gem 'active_storage-send_zip' -``` - -And then execute: - - $ bundle - -Or install it yourself as: - - $ gem install active_storage-send_zip +Add a `send_zip` method in your Rails controller to send a `.zip` file containing one or many [ActiveStorage](https://edgeguides.rubyonrails.org/active_storage_overview.html) objects. ## Usage @@ -96,6 +80,22 @@ Will produce a `.zip` archive like this: └── c.gif ~~~ +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'active_storage-send_zip' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install active_storage-send_zip + ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. diff --git a/active_storage-send_zip.gemspec b/active_storage-send_zip.gemspec index 6e15719..c658b38 100644 --- a/active_storage-send_zip.gemspec +++ b/active_storage-send_zip.gemspec @@ -9,7 +9,7 @@ Gem::Specification.new do |spec| spec.email = ['contact@rousseau-alexandre.fr'] spec.summary = 'Create a zip from one or more Active Storage objects' - spec.description = 'Create a zip from one or more Active Storage objects and return it in a rails controller' + spec.description = 'Add a `send_zip` method in your Rails controller to send a `.zip` file containing one (or many) ActiveStorage object(s)' spec.homepage = 'https://github.com/madeindjs/active_storage-send_zip' spec.license = 'MIT'