Add README, update notification gif and change wording

This commit is contained in:
Tanner Collin 2017-01-04 00:32:41 +00:00
parent a724e99bfc
commit 4196c8c059
3 changed files with 40 additions and 4 deletions

View File

@ -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.

View File

@ -21,11 +21,11 @@ export default class Home extends React.Component {
<div className="six columns"> <div className="six columns">
<p><code>$ long-running-command; notica Finished!</code></p> <p><code>$ long-running-command; notica Finished!</code></p>
<p> <p>
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.
</p> </p>
</div> </div>
<div className="six columns"> <div className="six columns">
<p><img className="u-max-full-width" src="https://i.imgur.com/TNb5kRQ.gif" /></p> <p><img className="u-max-full-width" src="https://i.imgur.com/476ezFy.gif" /></p>
</div> </div>
</div> </div>
<div className="row"> <div className="row">
@ -61,7 +61,7 @@ export default class Home extends React.Component {
Notica was written by <a href="http://tannercollin.com" target="_blank">Tanner Collin</a> after he got tired of checking if his commands were done running. Notica was written by <a href="http://tannercollin.com" target="_blank">Tanner Collin</a> after he got tired of checking if his commands were done running.
</p> </p>
<p> <p>
Notica <strike>is</strike> <i>will be, once it's done,</i> free and open-source software: <a href="https://github.com/tannercollin/Notica" target="_blank">https://github.com/tannercollin/Notica</a> Notica is free and open-source software: <a href="https://github.com/tannercollin/Notica" target="_blank">https://github.com/tannercollin/Notica</a>
</p> </p>
<p> <p>
Thanks to exdevlin for thinking of the name. Thanks to all the devs behind Node.js, React, webpack, and socket.io. Thanks to exdevlin for thinking of the name. Thanks to all the devs behind Node.js, React, webpack, and socket.io.

View File

@ -128,7 +128,7 @@ export default class NotifPage extends React.Component {
</div> </div>
<div className="row"> <div className="row">
<div className="six columns"> <div className="six columns">
<h4>Usage</h4> <h4>Examples</h4>
<p>Here are some different ways to use Notica:</p> <p>Here are some different ways to use Notica:</p>
<p> <p>
Just run it from your terminal: <br /> Just run it from your terminal: <br />