nookies - npm Package Compare versions

Comparing version 2.0.3 to 2.0.4

package.json

 {
   "name": "nookies",
   "description": "A set of cookie helpers for Next.js",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "main": "dist/index.js",
@@ -6,0 +6,0 @@ "types": "dist/index.d.ts",

README.md

@@ -7,10 +7,12 @@ # nookies :cookie: :cookie: :cookie:
 
-- SSR support, for setter, parser and destory
+- SSR support, for setter, parser and destroy
 - super light
 - perfect for authentication
 
-Setting and destorying cookies also works on server-side.
+Setting and destroying cookies also works on server-side.
 
 ## Quick start
 
+### SSR cookies
+
 ```js
@@ -66,6 +68,26 @@ import { parseCookies, setCookie, destroyCookie } from 'nookies'
 
+### Cookies on the client
+
+```js
+import nookies from 'nookies'
+
+export default class Me extends React.Component {
+  handleClick = () => {
+    // Simply omit context parameter.
+    const cookies = parseCookies()
+    console.log({ cookies })
+  }
+
+  render() {
+    return <button onClick={this.handleClick}>Click Me!</button>
+  }
+}
+```
+
 ### Reference
 
-#### `parseCookies(ctx, options) or cookies.get(ctx, options)`
+> For client side usage, omit the `ctx` parameter. You can do so by setting it to an empty object (`{}`).
 
+#### `parseCookies(ctx, options)` or `cookies.get(ctx, options)`
+
 - **ctx:** `Next.js context`
@@ -75,3 +97,3 @@ - **options:**
 
-#### `setCookie(ctx, name, value, options) or cookies.set(ctx, name, value, options)`
+#### `setCookie(ctx, name, value, options)` or `cookies.set(ctx, name, value, options)`
 
@@ -91,3 +113,3 @@ - **ctx:** `(Next.js context)`
 
-#### `destroyCookie(ctx, name) or cookies.destroy(ctx, 'token')`
+#### `destroyCookie(ctx, name)` or `cookies.destroy(ctx, 'token')`
 
@@ -94,0 +116,0 @@ - **ctx:** (Next.js context)

No alert changes

Improved metrics

Total package byte prevSize

234142

increased by0.2%

Number of lines in readme file

118

increased by22.92%

No dependency changes