Add local DDB version info to README, remove config/test.exs from .gitignore

Author: darrenklein

.gitignore

@@ -18,6 +18,3 @@ erl_crash.dump
 
 # Also ignore archive artifacts (built via "mix archive.build").
 *.ez
-
-# Ignore config/test.exs to avoid unintentionally interfering with a user's local DDB instance. See README.
-config/test.exs

README.md

@@ -23,6 +23,12 @@ end
 
 Documentation can be found at [https://hexdocs.pm/ex_aws_dynamo](https://hexdocs.pm/ex_aws_dynamo).
 
+## Requirements
+
+### DynamoDB Local
+
+If you are running this module against a local version of DynamoDB, you'll want to make sure that you have installed the latest version, currently `1.11.477` (released 2019-02-06). You can find links to download the latest version [here](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.DownloadingAndRunning.html)
+
 ## Configuration
 
 ### `decode_sets`
@@ -46,30 +52,11 @@ This application supports three test commands:
 
 ### Integration tests (optional)
 
-The tests in `test/lib/dynamo/integration_test.exs` will attempt to run against a running local instance of DynamoDB - in order to run these tests, you will need both a running local instance of DynamoDB as well as a `config/test.exs` file (currently .gitignored) formatted like so:
-
-`config/test.exs`
-```elixir
-use Mix.Config
-
-config :ex_aws,
-  debug_requests: false,
-  access_key_id: "abcd",
-  secret_access_key: "1234",
-  region: "us-east-1"
-
-config :ex_aws, :dynamodb,
-  scheme: "http://",
-  host: "localhost",
-  port: CHOOSE_YOUR_TEST_PORT,
-  region: "us-east-1"
-```
-
-(also available in `config/test.exs.example`)
+The tests in `test/lib/dynamo/integration_test.exs` will attempt to run against a local instance of DynamoDB - in order to run these tests, you will need a running local instance of DynamoDB and will need to uncomment the contents of `config/test.exs`, setting the value of `:port` to match Dynamo's port.
 
-Before setting the `port`, be aware that `integration_test.exs` will create and delete tables with the names `"TestUsers"`, `"Test.User"`, `"TestSeveralUsers"`, `"TestFoo"`, `"test_books"`, `"TestUsersWithRange"`, `"TestTransactions"`, `"TestTransactions2"` - be careful when setting the port, as these operations may affect your current tables if they share any of those names.
+Before setting the `:port`, be aware that `integration_test.exs` will create and delete tables with the names `"TestUsers"`, `"Test.User"`, `"TestSeveralUsers"`, `"TestFoo"`, `"test_books"`, `"TestUsersWithRange"`, `"TestTransactions"`, `"TestTransactions2"` - be careful when setting the port, as these operations may affect your current tables if they share any of those names.
 
-If you do not have a running local instance of DynamoDB and/or you don't provide a valid `config/test.exs` file, the integration tests will be ignored.
+If you do not have a running local instance of DynamoDB and/or you don't uncomment the contents of `config/test.exs`, the integration tests will be ignored.
 
 ## License
 

config/test.exs

@@ -0,0 +1,18 @@
+use Mix.Config
+
+###################################################################
+# Uncomment the configuration below and set the value for :port
+# in order to run the tests in test/lib/dynamo/integration_test.exs
+###################################################################
+
+# config :ex_aws,
+#   debug_requests: false, # set to true to monitor the DDB requests
+#   access_key_id: "abcd",
+#   secret_access_key: "1234",
+#   region: "us-east-1"
+
+# config :ex_aws, :dynamodb,
+#   scheme: "http://",
+#   host: "localhost",
+#   port: SET_YOUR_TEST_PORT,
+#   region: "us-east-1"