Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
taylordaughtry committed Feb 4, 2016
1 parent 3aa7af0 commit 0b0e592
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Expand Up @@ -2,32 +2,30 @@

# Brief

![Craft](https://img.shields.io/badge/craft-v2.4-orange.svg)
![Craft](https://img.shields.io/badge/craft-v2.5-orange.svg)

Brief is a light plugin that allows you to notify a certain user group when
new entries are added to a section.

## Features

This module is in active development. You're free to use this on your sites, and
are encouraged to open an issue if you find that something's not working as it
should.
This module is in active development. If you need a feature, let me know and I'll add it as soon as reasonably possible. If you encounter any issues, please open an issue and I'll work with you and patch the problem. Thanks!

## Additions
- Email Modification
- ~~Settings page~~
- ~~Section/Single/Structure Selection~~
- ~~User Group Selection~~
## Feature Roadmap
- Add email templates from ThemeForest, CodeCanyon, and elsewhere that work with Brief automatically
- Easily build custom email templates with Twig, just like any other template.
- Add multiple notification groups for multiple sections
- Specify whether you'd like notifications for *any* entry, or just new ones.

## Usage

1. Install the plugin by putting the `brief` directory in your `craft/plugins`
folder.
2. Go to the plugin settings and select which section you'd like Brief to watch.
3. Select the User Group you'd like to notify about any new entries.
3. Select the User Group you'd like to notify about any new entries. If you don't
have any user groups, Brief will tell you.
4. Click 'Save'. You're done!

Any users in your selected group will now recieve email notifications when a new
Any users in your selected group will now receive email notifications when a new
entry is added to your section. If you add new users to that group, Brief will
add them to the notification list automatically; you don't need to do anything
else.
add them to the notification list automatically; you don't need to do anything else.

0 comments on commit 0b0e592

Please sign in to comment.