https://github.com/zachallett/growl

Simple wrapper for growl, the notification system for OSX
https://github.com/zachallett/growl

Last synced: 2 months ago
JSON representation

Simple wrapper for growl, the notification system for OSX

• Host: GitHub
• URL: https://github.com/zachallett/growl
• Owner: zachallett
• License: mit
• Created: 2014-10-24T01:45:07.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2017-11-17T18:48:24.000Z (about 7 years ago)
• Last Synced: 2024-10-02T07:27:49.769Z (3 months ago)
• Language: Elixir
• Size: 44.9 KB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Simple wrapper for growl, the notification system for OSX. (Miscellaneous)
• fucking-awesome-elixir - growl - Simple wrapper for growl, the notification system for OSX. (Miscellaneous)
• awesome-elixir - growl - Simple wrapper for growl, the notification system for OSX. (Miscellaneous)

README

        
# Growl

A simple wrapper to the command line interface for the [Growl OSX notification system](http://growl.info/).

## Setup

```Elixir

defp deps do

  [

    {:growl, github: "zachallett/growl"}

  ]

```

## Usage

Within the script you would like to create a `growl` notification, make the module call as follows:

```Elixir

Growl.notify("This is a notification")

```

The API accepts messages in a string format, as well as a list. If the first argument is a list, the first object is the title line, with subsequent lines being the body of the notification.

```Elixir

Growl.notify(["Example", "This is an example notification"])

```

would give the following notification:

![Forced Update](https://github.com/zachallett/growl/blob/master/multi_line_notification.png?raw=true "Multi-Line notification Screenshot"))

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request