diff options
| author | Adam Soltys <[email protected]> | 2023-01-24 13:27:27 -0800 |
|---|---|---|
| committer | Adam Soltys <[email protected]> | 2023-01-24 13:27:27 -0800 |
| commit | 9e933e6e11f4bec490010664a54a185a3c53ee42 (patch) | |
| tree | 432947399a7846cdc3a1f0feea37376efb16197f | |
| parent | 3670a60dbe07ab06697cfd1ad857f99421832647 (diff) | |
| download | coinos-ui-9e933e6e11f4bec490010664a54a185a3c53ee42.tar.gz coinos-ui-9e933e6e11f4bec490010664a54a185a3c53ee42.zip | |
update readme
| -rw-r--r-- | README.md | 30 |
1 files changed, 6 insertions, 24 deletions
@@ -1,30 +1,12 @@ -# coinos-ui-v2 +# Coinos -coinos is an easy to use bitcoin point of sale application for businesses and wallet for customers, connecting the bitcoin circular economy together. +Coinos is a web-based bitcoin and nostr client. You can use it as a front end to your personal bitcoin and lightning nodes or host a public instance that allows anyone to register with a username and password. Try ours at https://coinos.io -This repository is the latest front-end code for the coinos web application. - -## Commands +## Install To get started, clone or download the repo, then: -- run `pnpm install` inside the repo once to install all dependencies (and whenever you pull new commits) -- run `pnpm run dev` every time you want to start up the UI -- run `pnpm format` to format the code before committing any changes - -This is a frontend for [`coinos-server`](https://github.com/coinos/coinos-server), so you will need to have that running in order for this UI to be useful. - -## Libraries - -This UI uses the following libraries: - -- [`sveltekit`](https://kit.svelte.dev/) as the JavaScript framework -- [`tailwindcss`](https://tailwindcss.com/) for inline styling -- [`pnpm`](https://pnpm.io/) as the recommended package manager -- [`prettier`](https://prettier.io/) as the code formatting standard and tool - -## Extra Features - -### Internationalization + pnpm install + pnpm run dev -coinos has a system for translation using [`sveltekit-i18n`](https://www.npmjs.com/package/sveltekit-i18n). For more information and instructions on how to translate coinos, click [here](./doc/i18n.md). For technical details, click [here](./doc/i18n-technical.md). +You'll need to run [`coinos-server`](https://github.com/coinos/coinos-server) as well |
