Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
apop880 committed Feb 14, 2023
1 parent 021f955 commit aa13100
Showing 1 changed file with 5 additions and 35 deletions.
40 changes: 5 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,8 @@
# create-svelte
# Photodash

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
![Photodash Logo](/logo.png)

## Creating a project
Photodash is an alternative dashboard for Home Assistant with a focus on serving as a digital photo frame. It aims to be easy to configure and maintain and supports displaying local photos or images from Google Photos.

If you're seeing this, you've probably already done this step. Congrats!

```bash
# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app
```

## Developing

Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:

```bash
npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open
```

## Building

To create a production version of your app:

```bash
npm run build
```

You can preview the production build with `npm run preview`.

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
> **Note**
> Photodash is in beta and in heavy development. There will be some bugs and breaking changes, though I have waited for things to be relatively stable for an initial beta release.

0 comments on commit aa13100

Please sign in to comment.