From ed09b66292329b193f7dd63ca685189223fbccad Mon Sep 17 00:00:00 2001
From: Florian Bouillon <florian.bouillon@delta-wings.net>
Date: Tue, 20 Oct 2020 12:28:38 +0200
Subject: [PATCH] Added Readme to url manager

Signed-off-by: Florian Bouillon <florian.bouillon@delta-wings.net>
---
 packages/url-manager/README.md | 91 ++++++++++++++++++++++++++++++++++
 1 file changed, 91 insertions(+)
 create mode 100644 packages/url-manager/README.md

diff --git a/packages/url-manager/README.md b/packages/url-manager/README.md
new file mode 100644
index 0000000..1fd3d73
--- /dev/null
+++ b/packages/url-manager/README.md
@@ -0,0 +1,91 @@
+# URL Manager
+
+simple to use yet powerful Urls parser and formatter
+
+## Usage
+
+- Import URLManager
+
+```typescript
+import URLManager from '@dzeio/url-manager'
+// or
+const URLManager = require('@dzeio/url-manager').default
+```
+
+- or import it from the browser
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@dzeio/url-manager@1/dist/browser.js"></script>
+<!-- It will be available as the same variable -->
+```
+
+- Create a new instance
+
+```typescript
+// Create a new instance
+const url = new URLManager() // you can have an URL, URLSearchParams Objects or a string as parameter
+// or
+const url = URLManager.fromLocation() // Browser only return a new instance from the current location
+```
+
+- manipulate the url
+
+```typescript
+
+// Get set delete query
+url.query("sort") // get
+url.query("sort", 'value') // set
+url.query("sort", null) // delete
+
+// get set the path
+url.path() // get
+url.path('/path') // set
+
+// get set the protocol
+url.protocol() // get
+url.protocol('https') // set
+
+// get set the multiple protocols
+url.potocols() // get
+url.protocols(['git', 'ssh']) //set
+
+// get set the domain
+url.domain() // get
+url.domain('dzeio.com') // set
+
+// get set the username
+url.username() // get
+url.username('avior') // set
+
+// get set the password
+url.password() // get
+url.password('notapassword') // set
+
+// get set the port
+url.port() // get
+url.port(22) // set
+
+// get set the hash
+url.hash() // get
+url.hash('i-am-a-hash') // set
+```
+
+- format it back to a string
+
+```typescript
+
+url.toString()
+`${url}`
+
+// NOTE: if the path contains elements like [param]
+// you can replace them in the toString function like this
+url.toString({param: 'test'})
+```
+
+- you have also two "util" functions (Available only in the browser)
+
+```typescript
+url.reload() // reload the current page
+url.go() // go to the url
+url.go(false) // show the next url in the browser without changing the content of the document
+```