Skip to content
This repository has been archived by the owner on Aug 5, 2024. It is now read-only.

Commit

Permalink
Modified Readme to include an explanation of the missing features
Browse files Browse the repository at this point in the history
  • Loading branch information
OrigamingWasTaken committed Feb 4, 2024
1 parent 10e4382 commit 6a059e5
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 0 deletions.
Binary file added .github/assets/notif.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/bun.lockb
.tmp
window_state_config.json
.storage

# Created by https://www.toptal.com/developers/gitignore/api/svelte,node,macos,windows,linux,git
# Edit at https://www.toptal.com/developers/gitignore?templates=svelte,node,macos,windows,linux,git
Expand Down
44 changes: 44 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,48 @@

AutoEvent is a lightweight and blazing fast event launcher built with [Neutralino](https://neutralino.js.org) and [Svelte](https://svelte.dev). It is currently in construction.

## Features

AutoEvent can notify you of upcoming events, while consumming close to no ram while running in the background. Clicking the alert will directly take you the the launch steps.

<figure>
<img
src=".github/assets/notif.png"
alt="Image of what the notifications look like" style="width:50%;">
<figcaption>Image of what the notifications look like</figcaption>
</figure>

## Roadmap

Currently, a lot of features aren't present on certain platforms (ex: notifications and app focus don't work on linux and windows). This is due to the fact that the main dev (OrigamingWasTaken) is on MacOS, and can't develop for other OSes. So you are very welcome to help us implement the missing features!

### Curated list of need-to-implement features

**Mac**
- [x] Notifications
- [x] Alerts
- [x] Window functions
- [x] Autostarting
- [x] URL Scheme

**Windows**
- [ ] Notifications
- [ ] Alerts
- [ ] Window functions
- [ ] Autostarting
- [ ] URL Scheme

**Linux**
- [ ] Notifications
- [ ] Alerts
- [ ] Window functions
- [ ] Autostarting
- [ ] URL Scheme

## Nightly Builds

You can download the app from the [nightly builds](https://nightly.link/Communaute-Events/AutoEvent/workflows/build/main?preview)

## Building

(Note: If you're on Windows, you must install WSL)
Expand Down Expand Up @@ -38,4 +80,6 @@ Run the build script for your target OS
./build linux
# Windows
./build win
# All platforms
./build all
```

0 comments on commit 6a059e5

Please sign in to comment.