From c67bdd41d0263252c7d9ac66b583b68e7883b3fb Mon Sep 17 00:00:00 2001
From: Ayo Ayco <ramon.aycojr@gmail.com>
Date: Sun, 16 Jul 2023 12:24:22 +0200
Subject: [PATCH] chore: update readme

---
 README.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 52e0554..1337388 100644
--- a/README.md
+++ b/README.md
@@ -3,4 +3,34 @@
 Utilities for serializing data from server for use in the client.
 
 1. `Resumable` Astro component takes `id` and `data`
-1. `resume(id: string): Object` function for use int he client takes an `id` string and returns the `data` as Object
\ No newline at end of file
+1. `resume(id: string): Object` function for use int he client takes an `id` string and returns the `data` as Object
+
+## Intallation
+
+```
+npm i @ayco/astro-resume
+```
+
+## Usage
+
+```astro
+---
+import Resumable from '../Resumable.astro';
+const data = {
+    hello: 'world'
+}
+---
+
+<Resumable id="astro-obj" data={data} />
+
+<div id="render-here"></div>
+
+<script>
+    import resume from '../resume';
+    console.log(resume('astro-obj'));
+    const renderDiv = document.querySelector('#render-here');
+    if (renderDiv) {
+        renderDiv.innerHTML =  JSON.stringify(resume('astro-obj'))
+    }
+</script>
+```
\ No newline at end of file