diff --git a/README.md b/README.md index e69de29..00f8643 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,36 @@ +# Notica +Send browser notifications from your terminal. No installation. No registration. + +https://notica.us/ + +## Usage + +Notica is a Bash function / alias that sends a notification to a tab in your browser when it's ran: + +``` +$ long-running-command; notica Finished! +``` + +This will wait until the first command completes before running Notica. +That way you can go do other things while your long task runs. +Then you will recieve a notification on any devices that have the Notica website open. + +![Notification Example gif](https://i.imgur.com/476ezFy.gif) + +## Setup + +Please follow the instructions on the Notica home page since they are generated specific to you: + +https://notica.us/ + +## Source Code + +### License + +Notica is free and open-source software released under the MIT License. + +### Self-hosting + +Hosting Notica on your own server is extremely easy. +Clone this repository, change all notica.us URLs to your own domain, and then run `npm install && npm start`. +You can connect to it directly or through a reverse proxy. diff --git a/src/ui/Home.js b/src/ui/Home.js index 54ac378..ff07291 100644 --- a/src/ui/Home.js +++ b/src/ui/Home.js @@ -21,11 +21,11 @@ export default class Home extends React.Component {

$ long-running-command; notica Finished!

- This will wait until the first command completes before running Notica. That way you can go do other things while your long task runs. Then you will recieve a notification. + This will wait until the first command completes before running Notica. That way you can go do other things while your long task runs. Then you will recieve a notification on any devices that have the Notica website open.

-

+

@@ -61,7 +61,7 @@ export default class Home extends React.Component { Notica was written by Tanner Collin after he got tired of checking if his commands were done running.

- Notica is will be, once it's done, free and open-source software: https://github.com/tannercollin/Notica + Notica is free and open-source software: https://github.com/tannercollin/Notica

Thanks to exdevlin for thinking of the name. Thanks to all the devs behind Node.js, React, webpack, and socket.io. diff --git a/src/ui/NotifPage.js b/src/ui/NotifPage.js index 365ffd2..800ee70 100644 --- a/src/ui/NotifPage.js +++ b/src/ui/NotifPage.js @@ -128,7 +128,7 @@ export default class NotifPage extends React.Component {

-

Usage

+

Examples

Here are some different ways to use Notica:

Just run it from your terminal: