From 76f5a96a4f33dd4a4247a639e1869dcdbdf82386 Mon Sep 17 00:00:00 2001
From: kobe koto <91669733+kobe-koto@users.noreply.github.com>
Date: Sat, 15 Oct 2022 12:36:30 +0800
Subject: [PATCH] how to use

---
 .idea/workspace.xml |  2 +-
 readme.md           | 20 ++++++++++++++++++++
 2 files changed, 21 insertions(+), 1 deletion(-)
 create mode 100644 readme.md

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index d463ad3..c9bc43d 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -45,7 +45,7 @@
       <option name="presentableId" value="Default" />
       <updated>1665803083606</updated>
       <workItem from="1665803085146" duration="1320000" />
-      <workItem from="1665805248286" duration="2573000" />
+      <workItem from="1665805248286" duration="3301000" />
     </task>
     <servers />
   </component>
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..8f0e563
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,20 @@
+# Counter based on Cloudflare Workers & KV
+
+## TL;DW ~~(Too Long, Don't write.)~~
+
+1. bind KV as a variable "CounterSpace".
+2. use it follow down below.
+
+## How to use?
+
+just add these parameter
+
+- `?visitor` returns total visitor count.
+- `?hit` returns total hits count.
+- `?text=...(your encoded words)...` returns a replaced text (encode your words using `btoa(encodeURI("some s*ck words"))`).
+
+### about `?text=...(your encoded words)...`
+
+- `@CounterByKoto_Visitors` will replace to total VISITORS count.
+- `@CounterByKoto_Hits` will replace to total HITS count.
+- `@CounterByKoto_NameSpace` will replace to total NAMESPACE.