From 5492be52103d2237a8782a86f0f6f89d2fb5a06e Mon Sep 17 00:00:00 2001 From: David Heinemeier Hansson Date: Wed, 5 Jul 2017 18:30:15 +0200 Subject: Bit further on the README --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7fc1e43e07..4a554ac18f 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ # Active Vault -... +Active Vault makes it simple to upload and reference files in cloud sites, like Amazon S3 or Google Cloud Storage, +and attach those files to Active Records. It also provides a disk site for testing or local deployments, but the +focus is on cloud storage. ## Example +One attachment: + ```ruby class User < ApplicationRecord has_one_attached :avatar @@ -25,6 +29,38 @@ class AvatarsController < ApplicationController end ``` +Many attachments: + +```ruby +class Message < ApplicationRecord + has_many_attached :images +end + +<%= form_with model: @message do |form| %> + <%= form.text_field :title, placeholder: "Title" %>
+ <%= form.text_area :content %>

+ + <%= form.file_field :images, multiple: true %>
+ <%= form.submit %> +<% end %> + +class MessagesController < ApplicationController + def create + message = Message.create! params.require(:message).permit(:title, :content) + message.images.attach(params[:message][:images]) + redirect_to message + end +end +``` + +## Configuration + +Add `require "active_vault"` to config/application.rb and create a `config/initializers/active_vault_sites.rb` with the following: + +```ruby + +``` + ## License Active Vault is released under the [MIT License](https://opensource.org/licenses/MIT). -- cgit v1.2.3