aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsecondl1ght <[email protected]>2022-07-20 10:48:34 -0600
committersecondl1ght <[email protected]>2022-07-20 10:48:34 -0600
commit09f5730f206fa67542c063e5419092e04f296440 (patch)
treeff49f0e04aa882782a88c4dc4a4120885b270b9e /README.md
downloadcoinos-ui-09f5730f206fa67542c063e5419092e04f296440.tar.gz
coinos-ui-09f5730f206fa67542c063e5419092e04f296440.zip
initial commit, setup the project with sveltekit, tailwindcss, prettier
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
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.