From 4413da42cdb91eed62b5d72418b7ff6571896d17 Mon Sep 17 00:00:00 2001
From: Samuel Kopp <62482066+unvented@users.noreply.github.com>
Date: Sat, 23 Jul 2022 20:17:42 +0200
Subject: [PATCH] docs: update readme for v6 (#103)

Update README for v6, including updated usage guide and feature list.
---
 .changeset/thick-news-explain.md |  7 ++++++
 .github/workflows/release.yml    |  2 ++
 README.md                        | 41 +++++++++++++++++---------------
 3 files changed, 31 insertions(+), 19 deletions(-)
 create mode 100644 .changeset/thick-news-explain.md

diff --git a/.changeset/thick-news-explain.md b/.changeset/thick-news-explain.md
new file mode 100644
index 0000000..0b86ec8
--- /dev/null
+++ b/.changeset/thick-news-explain.md
@@ -0,0 +1,7 @@
+---
+"cachu": patch
+---
+
+docs: update readme for v6
+
+Update README for v6, including updated usage guide and feature list.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 25078ce..21a6086 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -44,6 +44,8 @@ jobs:
         with:
           version: npx changeset version
           publish: npx changeset publish
+          commit: 'ci: version packages'
+          title: 'ci: version packages'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/README.md b/README.md
index d404fb9..bc4408f 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,4 @@
-<div align='center'>
-  <h1>cachu</h1>
-  </br></br>
-</div>
-
-> **Notice**
-Need an introduction to v6? [Here](https://gist.github.com/unvented/dab8d3e987cfdd79f68e715d29c1ee17) you go!
+# cachu
 
 ## Setup
 
@@ -18,20 +12,14 @@ npm i cachu@dev
 
 ## Usage
 
-### Deno
-
-```typescript
-import { useCache } from 'https://deno.land/x/cachu@v6.0.0/mod.ts'
-
-const cache = await useCache()
-```
+> **Note** - Need an introduction to v6? [Here](https://gist.github.com/unvented/dab8d3e987cfdd79f68e715d29c1ee17) you go!
 
 ### Node.js
 
 ```js
 import { useCache } from 'cachu'
 
-const cache = await useCache()
+const cache = useCache()
 
 // Add a new entry.
 await cache.add('one', 'Hello World')
@@ -39,6 +27,21 @@ await cache.add('one', 'Hello World')
 const entry = await cache.get('one') // 'Hello World'
 ```
 
+### Deno
+
+```typescript
+import { useCache } from 'https://deno.land/x/cachu@v6.0.0/mod.ts'
+```
+
+### Browser
+
+```typescript
+import { useCache } from 'cachu/browser'
+
+// Alternatively, you might want to use a CDN.
+import { useCache } from 'https://cdn.jsdelivr.net/npm/cachu@6'
+```
+
 ## API
 
 * #### Configuration
@@ -48,14 +51,14 @@ const entry = await cache.get('one') // 'Hello World'
 
 * #### Features
 
-  * [`add()`](/guide/features/set.md)
-  * [`addMany()`](/guide/features/setMany.md)
+  * [`add()`](/guide/features/add.md)
+  * [`addMany()`](/guide/features/addMany.md)
   * [`get()`](/guide/features/get.md)
   * [`getMany()`](/guide/features/getMany.md)
   * [`update()`](/guide/features/update.md)
   * [`updateMany()`](/guide/features/updateMany.md)
-  * [`remove()`](/guide/features/delete.md)
-  * [`removeMany()`](/guide/features/deleteMany.md)
+  * [`remove()`](/guide/features/remove.md)
+  * [`removeMany()`](/guide/features/removeMany.md)
   * [`has()`](/guide/features/has.md)
   * [`size()`](/guide/features/size.md)
   * [`keys()`](/guide/features/keys.md)