From 78274a522acecfeac036fa8df37a63375ac1cab5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Eduard=20Bardaj=C3=AD=20Puig?= Date: Mon, 2 Sep 2024 19:39:02 +0200 Subject: [PATCH] Update docs --- README.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b792970..e5fd19a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ -# pool-tools +# stacks-tools -A collection of methods for the Stacks API and to manage pools. +A collection of methods for calling the Stacks API and managing Stacks pools. -Supports ESM imports only. +## Quickstart + +Install dependencies with + +```shell +bun install +``` + +and build the package with + +```shell +bun run build +```