aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamantha McVey <samantham@posteo.net>2017-04-25 13:10:57 -0700
committerSamantha McVey <samantham@posteo.net>2017-04-25 13:10:57 -0700
commitc055b5ed24cddd2a8621a54bd8801cc367076aa2 (patch)
tree07c2659e138c547e3f3d94691bcdf08948faaad0
parent8571136ce42e05503f933bd1336547fc17637e42 (diff)
Update README.md
-rw-r--r--README.md12
-rw-r--r--readme.md2
2 files changed, 12 insertions, 2 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d90b1b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+[![Build Status](https://travis-ci.org/scriptkitties/p6-Hash-Merge.svg?branch=master)](https://travis-ci.org/scriptkitties/p6-Hash-Merge)
+
+### method merge
+
+```
+method merge(
+ %b,
+ Bool:D :$no-append-array = Bool::False
+) returns Mu
+```
+
+Merges a second hash into the hash the method is called on. Hash given as the argument is not modified. Traverses the full tree, replacing items in the original hash with the hash given in the argument. Does not replace positional elements by default, and instead appends the items from the supplied hash's array to the original hash's array. The object type of positionals is not retained and instead becomes an Array type. Use :no-append-array to replace arrays and positionals instead, which will also retain the original type and not convert to an Array
diff --git a/readme.md b/readme.md
deleted file mode 100644
index 9efc62f..0000000
--- a/readme.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# Hash::Merge
-Module to add deep merge functionality to Hashes.