Skip to content

Commit

Permalink
update_readme
Browse files Browse the repository at this point in the history
  • Loading branch information
forever8896 committed Oct 24, 2024
1 parent 969b745 commit fc67191
Showing 1 changed file with 21 additions and 10 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# CrypTick

This is a Tauri application for receiving crypto price alerts, built with Svelte and Vite, Built from the create-tauri-app command. With the 7th chapter of the rust book read, I wanted to jump in and build something.
This is a Tauri application for receiving crypto price alerts, built with Svelte and Vite, created using the `create-tauri-app` command. After reading the 7th chapter of the Rust book, I wanted to jump in and build something.

## Features

- Fetching of crypto prices from the Binance public websocket API
- Real-time crypto price alerts based on set prices.
- A couple fun sounds to choose from.
- Real-time crypto price alerts based on set prices
- A couple of fun sounds to choose from

## Installation

Expand All @@ -23,22 +23,33 @@ This is a Tauri application for receiving crypto price alerts, built with Svelte
npm install
```

3. Build the application:
## Development

```bash
npm run tauri build
```
To run the application in development mode with live-reloading, use the following command:

```bash
npm run tauri dev
```

This will start the Tauri development server and open the application. Any changes you make to the source files will automatically trigger a reload, allowing you to see your changes in real-time.

4. Find the executable in the `src-tauri/target/release` directory.
## Build

To build the application for production:

```bash
npm run tauri build
```

The executable will be located in the `src-tauri/target/release` directory.

## Usage

Run the executable found in `src-tauri/target/release` to start the application.

## Notes

Currently it only works on desktop, But I chose Tauri with the vision of making it cross platform in the future.

Currently, it only works on desktop, but I chose Tauri with the vision of making it cross-platform in the future.

## Recommended IDE Setup

Expand Down

0 comments on commit fc67191

Please sign in to comment.