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' +} +--- + + + +
+ + +``` \ No newline at end of file