URL: Adding a README for the URL Package

WordPress · Jul 25, 2017 · b9961a4 · b9961a4
1 parent a80a4df
commit b9961a4
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/packages/url/README.md b/packages/url/README.md
@@ -0,0 +1,20 @@
+# WordPress URL Package
+
+A collection of utilities to manipulate URLs
+
+## Installation
+
+Install the module
+
+```bash
+npm install @wordpress/url --save
+```
+
+## Usage
+
+```JS
+import { addQueryArgs } from '@wordpress/url';
+
+// Appends arguments to the query string of a given url
+const newUrl = addQueryArgs( 'https://google.com', { q: 'test' } ); // https://google.com/?q=test
+```