From d7910e724e50fa3631e7c390820df05c8ad5ff83 Mon Sep 17 00:00:00 2001 From: Shekhar Gulati Date: Tue, 3 May 2016 19:30:40 +0530 Subject: [PATCH] Added documentation of `append` and `appendArray` methods to README.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c3b4214 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +strman-java +------ + +A Java string manipulation library without any dependencies. It is inspired by [dleitee/strman](https://github.com/dleitee/strman). + + +## Available Functions + +* [append](https://github.com/shekhargulati/strman-java) +* [appendArray](https://github.com/shekhargulati/strman-java) + + +## append(value, strings...) + +This method will append `strings` to the `value`. + +```java +import static strman.Strman.append; +String title = "s"; +String result = append(title, "tr","m","an"); +// result = "strman" +``` + + +## appendArray(value, strings) + +This method will append all the values in `strings` array to the `value`. + +``` +import static strman.Strman.appendArray; +String title = "s"; +String result = appendArray(title, new String[]{"tr","m","an"}); +// result = "strman" +``` \ No newline at end of file