backsplash-app/README.md

An AI powered wallpaper app.

# Backsplash Desktop App

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Introduction

Backsplash is an AI-powered wallpaper generator that creates beautiful, custom wallpapers for your desktop.

## Features

- AI-generated wallpapers based on styles, moods, and locations
- Automatic wallpaper changing on a schedule
- History of previously used wallpapers
- Customizable styles and preferences
- Automatic updates via S3

## Screenshots

![Screenshot of the application on windows](./screenshots/window-win.png)

![Screenshot of the application on macOS](./screenshots/window-mac.png)

## Getting Started

To get started with this project, follow these steps:

1. Clone this repository
2. Install dependencies with `yarn install`
3. Run the application with `yarn dev`

## Building and Publishing

### Building the App

```bash
yarn make
```

### Publishing Updates

Backsplash uses Electron Forge with S3 publishing for automatic updates. See [PUBLISHING.md](./PUBLISHING.md) for detailed instructions on how to publish updates.

## Development

### Commands

- `yarn dev` - Start the app in development mode
- `yarn make` - Build the app for production
- `yarn publish-s3` - Publish the app to S3 for auto-updates
- `yarn lint` - Run ESLint
- `yarn format` - Format code with Prettier

## Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

## License

This project is licensed under the terms of the [MIT license](./LICENSE).