From 2e1ed890b85d4ecf1a6332cf2e0c121d5640b496 Mon Sep 17 00:00:00 2001
From: Vincent LE GOFF <g_n_s@hotmail.fr>
Date: Mon, 18 Mar 2019 16:08:01 +0100
Subject: Documentation clean up (denoland/deno_std#288)

Original: https://github.com/denoland/deno_std/commit/b699fa67befaef4423f365e55eff0fec2e14def8
---
 strings/README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 strings/README.md

(limited to 'strings')

diff --git a/strings/README.md b/strings/README.md
new file mode 100644
index 000000000..8b41fee67
--- /dev/null
+++ b/strings/README.md
@@ -0,0 +1,26 @@
+# Strings
+
+This module provides a few basic utilities to manipulate strings.
+
+## Usage
+
+### pad
+
+Input string is processed to output a string with a minimal length.
+If the parameter `strict` is set to true, the output string length
+is equal to the `strLen` parameter.
+
+Basic usage:
+
+```ts
+import { pad } from "https://deno.land/std/strings/pad.ts";
+pad("deno", 6, { char: "*", side: "left" }) // output : "**deno"
+pad("deno", 6, { char: "*", side: "right"}) // output : "deno**"
+pad("denosorusrex", 6 {
+    char: "*",
+    side: "left",
+    strict: true,
+    strictSide: "right",
+    strictChar: "..."
+}) // output : "den..."
+```
-- 
cgit v1.2.3