Update README

This commit is contained in:
Wesley Moore 2024-02-19 09:49:49 +10:00
parent 432baf06a9
commit f82df28368
No known key found for this signature in database

View file

@ -1,22 +1,31 @@
# videopls
# gleam-tauri-experiment
[![Package Version](https://img.shields.io/hexpm/v/videopls)](https://hex.pm/packages/videopls)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/videopls/)
This is [Tauri] application that uses [Gleam] and [Lustre] on the front-end via
[Vite].
## Quick start
## Building
```sh
gleam run # Run the project
gleam test # Run the tests
gleam shell # Run an Erlang shell
```
### Prerequisites
## Installation
You will need the following installed to build the application:
If available on Hex this package can be added to your Gleam project:
- Rust
- Gleam
- node.js & npm
```sh
gleam add videopls
```
Run `npm i` to install node packages.
### Build
Build the project with:
cargo tauri dev
This will compile all the code and start a development instance that will live
reload when changes are made.
[Tauri]: https://tauri.app/
[Gleam]: https://gleam.run/
[Lustre]: https://lustre.build/
[Vite]: https://vitejs.dev/
and its documentation can be found at <https://hexdocs.pm/videopls>.