From 42928444aaf6ae4e04f1a9383f5f3d0409d5b287 Mon Sep 17 00:00:00 2001
From: Sambo Chea <sombochea@cubetiqs.com>
Date: Thu, 20 Oct 2022 10:18:08 +0700
Subject: [PATCH] Fixed some bugs and updated docs

---
 CHANGELOG.md | 10 ++++++++++
 README.md    | 30 +++++++++++++++++++++---------
 package.json |  2 +-
 3 files changed, 32 insertions(+), 10 deletions(-)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..9045f84
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,10 @@
+### 20/10/2022
+
+-   Upgraded packages and fixed some bugs
+
+### Initialized
+
+-   HTTP tunnel between server and client via https link
+-   Custom profile (using `-p myprofile`)
+-   Suffix url (using `-s`)
+-   Config (get/set token,access,server,client,key configs)
diff --git a/README.md b/README.md
index 33d971f..5e27ee8 100644
--- a/README.md
+++ b/README.md
@@ -13,9 +13,15 @@ npx @cubetiq/hlt
 
 ```
 
-### Usage
+### Usages
 
-- Initialize Client and Start (Quick)
+-   If installed to global (bin), please using cli
+
+```shell
+hlt [command] [options]
+```
+
+-   Initialize Client and Start (Quick)
 
 ```shell
 # Initialize a client and token for connect (default's profile)
@@ -25,6 +31,12 @@ npx @cubetiq/hlt init
 npx @cubetiq/hlt start 3000
 ```
 
+# Start port 3000 with suffix to remote server
+
+npx @cubetiq/hlt start 3000 -s mytest
+
+````
+
 - Initialize Client and Start (Quick with custom's profile)
 
 ```shell
@@ -33,29 +45,29 @@ npx @cubetiq/hlt init -p mytest
 
 # Start port 3000 to remote server (mytest's profile)
 npx @cubetiq/hlt start 3000 -p mytest
-```
+````
 
 ### Custom Config
 
-- Generate Client Key
+-   Generate Client Key
 
 ```shell
 npx @cubetiq/hlt config client new
 ```
 
-- Set Client Token (Required, contact to vendor)
+-   Set Client Token (Required, contact to vendor)
 
 ```shell
 npx @cubetiq/hlt config token $TOKEN
 ```
 
-- Custom Server
+-   Set Custom Server
 
 ```shell
 npx @cubetiq/hlt config server https://lt.ctdn.net
 ```
 
-- Start Client
+-   Start Client
 
 ```shell
 npx @cubetiq/hlt start $YOUR_PORT
@@ -63,5 +75,5 @@ npx @cubetiq/hlt start $YOUR_PORT
 
 ### Contributors
 
-- Original [web-tunnel](https://github.com/web-tunnel/lite-http-tunnel-client)
-- Sambo Chea <sombochea@cubetiqs.com>
+-   Original [web-tunnel](https://github.com/web-tunnel/lite-http-tunnel-client)
+-   Sambo Chea <sombochea@cubetiqs.com>
diff --git a/package.json b/package.json
index 1ee307a..b178010 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cubetiq/hlt",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A lightweight http tunnel client using nodejs and socket.io client",
   "main": "dist/client.js",
   "bin": {