Fix readme

oramasearch · Nov 8, 2023 · 5705107 · 5705107
1 parent 571710f
commit 5705107
Showing 1 changed file with 3 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # Cloudflare API library
 
 [![Nodejs](https://github.com/oramasearch/cloudflare-api/actions/workflows/nodejs.yml/badge.svg)](https://github.com/oramasearch/cloudflare-api/actions/workflows/nodejs.yml)
-![npm package minimized gzipped size (select exports)](https://img.shields.io/bundlejs/size/%40orama%2Fcloudflare-api)
 
 This library is a wrapper around the Cloudflare API.
 
@@ -24,9 +23,9 @@ const ACCOUNT_ID = 'your-account-id'
 const NAMESPACE_ID = 'your-namespace-id'
 const workerKv = api.workerKv(ACCOUNT_ID, NAMESPACE_ID)
 
-await workerKv.uploadKv('key', 'value')
-await workerKv.getKv('key', 'value')
-await workerKv.deleteKv('key', 'value')
+await workerKv.uploadKv('key', 'value') // upload a value to the KV
+await workerKv.getKv('key', 'text') // return the text representation of the value
+await workerKv.deleteKv('key') // delete the value from the KV
 ```
 
 ## License