From d011b2219e72d7bccef7320f60b8349a6d672e69 Mon Sep 17 00:00:00 2001 From: Tim Smith <69870077+timscodebase@users.noreply.github.com> Date: Mon, 12 Dec 2022 16:40:17 -0800 Subject: [PATCH 1/2] New line This is a tiny change. But to my dislexic brain, this is easier to read --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d91c934..71eb73d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # 👻 Bookit 👻 [Demo](https://bookit.leveluptutorials.com/book) + Docs (coming soon) ## The least spooky way to build your components. From 5c7f766426e2967ebfc69d3e6814781597232249 Mon Sep 17 00:00:00 2001 From: Tim Smith <69870077+timscodebase@users.noreply.github.com> Date: Mon, 27 Feb 2023 16:17:29 -0800 Subject: [PATCH 2/2] Readme update --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 71eb73d..e04c597 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Docs (coming soon) -## The least spooky way to build your components. +## The least spooky way to build your components Pronounced Boo-Kit or Book-It @@ -19,3 +19,17 @@ A new Story environment with a different approach. Finely tuned to work directly - Themeable - Use your real data - Simple + +### How to install + +1. Download or clone the Bookit repo +2. Copy the `book` folder into the 'routes' folder of your Svelte Kit project + +### How to use + +Anywhere in your app, you create a '*.story.svelte' to show a component. You can also create a 'stories' folder to organize your stories. + +### '*.story.svelte' structure + +- title: The title of the component +- parent: The category of the component