Home

Awesome

<!-- ** DO NOT EDIT THIS FILE ** ** 1) Make all changes to `README.yaml` ** 2) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

zsh-notify

Build Status Issues Latest Release

zsh-notify plugin for zsh.

This project is part of our comprehensive hadenlabs plugins of zsh.

Requirements

This is a list of plugins that need to be installed previously to enjoy all the goodies of this configuration:

https://github.com/luismayta/zsh-core
https://github.com/luismayta/zsh-notify
https://github.com/luismayta/zsh-functions

Installation

oh-my-zsh users

If you're using oh-my-zsh, install this plugin by doing the following:

  1. Go to your oh-my-zsh custom plugins directory -cd ~/.oh-my-zsh/custom/plugins
  2. Clone the plugin bash git clone https://github.com/luismayta/zsh-notifybash
  3. Edit your .zshrc and add plugins=( ... zsh-notify ) to your list of plugins
  4. Open a new terminal and enjoy!

antigen users

If you're using Antigen, install this plugin by doing the following:

  1. Add antigen bundle luismayta/zsh-notify to your .zshrc where you're adding your other plugins.
  2. Either open a new terminal to force zsh to load the new plugin, or run antigen bundle luismayta/zsh-notify in a running zsh session.
  3. Enjoy!

antibody users

If you're using Antigen, install this plugin by doing the following:

  1. Add :
     antibody bundle luismayta/zsh-notify

to your .zshrc where you're adding your other plugins.

  1. Either open a new terminal to force zsh to load the new plugin, or run antibody bundle luismayta/zsh-notify in a running zsh session.
  2. Enjoy!

Usage

make setup

Help

Got a question?

File a GitHub issue, send us an [email][email] or join our [Slack Community][slack].

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to rebase the latest changes from "upstream" before making a pull request!

Versioning

Releases are managed using github release feature. We use [Semantic Versioning](http://semver.org) for all the releases. Every change made to the code base will be referred to in the release notes (except for cleanups and refactorings).

Copyright

Copyright © 2018-2021 Hadenlabs

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by [Hadenlabs][https://hadenlabs.com]. Like it? Please let us know at support@hadenlabs.com

Contributors

Luis Mayta<br/>Luis Mayta