Skip to content

Commit

Permalink
doc: revise
Browse files Browse the repository at this point in the history
  • Loading branch information
haberdashPI committed Aug 27, 2020
1 parent f653b7b commit 83d1120
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,21 @@

Alert provides a cross-platform means of displaying a notification to the user in Julia. It
should work on MacOS, Windows 10 (even under WSL2) and many flavors of Linux. This is handy
for long-running scripts.
for long-running scripts. You can also use an extension
([AlertPushover](https://github.com/haberdashPI/AlertPushover.jl)) to send notifications to
your phone or a webapp when working remotely.

There are three ways to use alert:

1. Call `alert()` after a long-running piece of code.
2. Put long-running code inside the `@alert` macro.
3. Call `alertREPL` and any long-running code sent to the REPL will display a notification.

Before using `alert()` at the end of a long-running script, it would be good to
test that it actually works on your system: some linux distros may not have
an appropriate program installed to display the notification. If it doesn't
work, just read the error message that is displayed to see what program you need
to install.
Before using `alert()` at the end of a long-running script, it would be good to test that it
actually works on your system: some linux distros may not have an appropriate program
installed to display the notification. Loading `Alert` should warn you if it can't find an
appropriate executable to send the notification. Just read the error message that is
displayed to see what program you need to install.

Table of Contents:
<!-- TOC -->
Expand Down

2 comments on commit 83d1120

@haberdashPI
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/20382

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.0 -m "<description of version>" 83d11200dc0b1bc73f72c4f17466e492ba586082
git push origin v0.2.0

Please sign in to comment.