release v1.0.0

elixir-waffle · Feb 4, 2020 · 8dcaede · 8dcaede
1 parent 940d5b7
commit 8dcaede
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,28 @@
 # Changelog
 
+## v1.0.0 (2020-02-04)
+  * remove poison and update dependencies (#30)
+  * define remote url as an attribute #29
+  * respect spaces in remote filenames (#28)
+
+### Upgrade instructions
+`ExAws` dependency was upgraded to the current version. Since most of
+community packages are migrating to `Jason` as a default library to
+work with JSON, we've decided to migrate `Waffle` as well. You can
+still use `Poison` as your JSON adapter, in such case just add it as a
+dependency.
+
+#### Before
+```
+config :ex_aws,
+  ...
+```
+#### After
+```
+config :ex_aws,
+  json_codec: Jason
+```
+
 ## v0.0.4 (2019-12-16)
   * Fixes link to waffle_ecto (#16)
   * add credo to project (#17)

diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ Add the latest stable release to your `mix.exs` file, along with the required de
 ```elixir
 defp deps do
   [
-    {:waffle, "~> 0.0.4"},
+    {:waffle, "~> 1.0.0"},
 
     # If using S3:
     {:ex_aws, "~> 2.1"},
@@ -45,7 +45,7 @@ Waffle expects certain properties to be configured at the application level:
 ```elixir
 config :waffle,
   storage: Waffle.Storage.S3, # or Waffle.Storage.Local
-  bucket: {:system, "AWS_S3_BUCKET"}, # if using Amazon s3
+  bucket: {:system, "AWS_S3_BUCKET"}, # if using S3
   asset_host: "http://static.example.com" # or {:system, "ASSET_HOST"}
 
 # If using S3:

diff --git a/lib/waffle.ex b/lib/waffle.ex
@@ -9,9 +9,9 @@ defmodule Waffle do
 
       defp deps do
         [
-          {:waffle, "~> 0.0.4"},
+          {:waffle, "~> 1.0.0"},
 
-          # If using Amazon S3:
+          # If using S3:
           {:ex_aws, "~> 2.1"},
           {:ex_aws_s3, "~> 2.0"},
           {:hackney, "~> 1.9"},
@@ -27,9 +27,13 @@ defmodule Waffle do
 
       config :waffle,
         storage: Waffle.Storage.S3, # or Waffle.Storage.Local
-        bucket: {:system, "AWS_S3_BUCKET"}, # if using Amazon s3
+        bucket: {:system, "AWS_S3_BUCKET"}, # if using S3
         asset_host: "http://static.example.com" # or {:system, "ASSET_HOST"}
 
+      # If using S3:
+      config :ex_aws,
+        json_codec: Jason
+
   Along with any configuration necessary for ExAws.
 
   ## Storage Providers

diff --git a/mix.exs b/mix.exs
@@ -1,7 +1,7 @@
 defmodule Waffle.Mixfile do
   use Mix.Project
 
-  @version "0.0.4"
+  @version "1.0.0"
 
   def project do
     [app: :waffle,