From 09f5730f206fa67542c063e5419092e04f296440 Mon Sep 17 00:00:00 2001
From: secondl1ght <85003930+secondl1ght@users.noreply.github.com>
Date: Wed, 20 Jul 2022 10:48:34 -0600
Subject: initial commit, setup the project with sveltekit, tailwindcss,
 prettier

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..6a2f1832
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# coinos-ui-v2
+
+coinos is an easy to use bitcoin point of sale application for businesses and wallet for customers, connecting the bitcoin circular economy together.
+
+this repository is the front-end code for the coinos web application, it uses `sveltekit` as the javascript framework, `tailwindcss` for inline styling, `pnpm` as the recommended package manager and `prettier` for code formatting.
+
+## commands
+
+to get started clone the repo and run `pnpm install`, then `pnpm run dev` to get your dev environment setup, and `pnpm format` to format the codebase when making changes.
-- 
cgit v1.2.3