Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RogueArt authored Jul 17, 2021
1 parent f44ac51 commit b91eb5e
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# About

USCIS notifier is a web app and daemon that notifies you via email and a desktop notification if your USCIS status has changed. USCIS notifier is built using HTML/CSS/JS on the frontend and vanilla JS on the backend.
USCIS notifier is a desktop app and daemon that notifies you via a desktop notification if your USCIS status has changed. USCIS notifier is built with Rust using the GTK for the GUI.

Currently, this compiles to an executable that can be run from the command line. A GUI is within the roadmap (see projects section of this repository).

![Screenshot 2021-07-17 155854](https://user-images.githubusercontent.com/57082175/126051114-db583cca-c63e-497a-8838-e699e029e2a8.png)

# Usage

Expand All @@ -16,4 +20,4 @@ Options include:
1. Clone this repository by running `REPLACE-THIS-LATER` through console.
2. Navigate to this repository through the terminal, run `npm i` to install packages.
3. Use `npm config` to configure and add IDs to the process.
4. Use `npm start` to start the background service (daemon) and watch for status updates.
4. Use `npm start` to start the background service (daemon) and watch for status updates.

0 comments on commit b91eb5e

Please sign in to comment.