From f60485b559d4acf2ff00a37290c01e0d7f2fc4ac Mon Sep 17 00:00:00 2001 From: Elliot Braem <16282460+elliotBraem@users.noreply.github.com> Date: Sun, 3 Dec 2023 18:49:36 -0500 Subject: [PATCH] docs: readme --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index be9ede2..e1a57ec 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,20 @@ # bluntdao-bos-components Blunt DAO workspace for all BOS components +## Getting Started -## Getting Started - -To run locally, make sure you have [bos-workspace](https://github.com/sekaiking/bos-workspace) installed. +``` +npm install +``` Then, run the command: -```bash -bw dev +``` +npm run dev ``` This will serve the widgets from `http://127.0.0.1:4040/`. + +Go to [everything.dev/flags](https://everything.dev) and paste this value there. + +Once set, see the locally served app at [bluntdao.near/widget/app](https://everything.dev/bluntdao.near/widget/app). \ No newline at end of file