Skip to content
This repository has been archived by the owner on Sep 2, 2023. It is now read-only.

Commit

Permalink
Updates URLs and community files
Browse files Browse the repository at this point in the history
  • Loading branch information
BenParizek committed Jun 22, 2019
1 parent 464804a commit 2c48e2a
Show file tree
Hide file tree
Showing 9 changed files with 61 additions and 94 deletions.
4 changes: 4 additions & 0 deletions .github/CODE_OF_CONDUCT.md
@@ -0,0 +1,4 @@
# Code of Conduct

We ask our users to respect the [Code of Conduct](https://docs.craftcms.com/v3/coc.html) of the greater Craft community.

3 changes: 3 additions & 0 deletions .github/CONTRIBUTING.md
@@ -0,0 +1,3 @@
# Contributing to Sprout Plugins

Please see the [Contributing](https://sprout.barrelstrengthdesign.com/docs/contributing.html) page in our documentation for details on contributing to Sprout Plugins.
15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE

This file was deleted.

26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,26 @@
---
name: Bug report
about: Tell us about a bug you may have identified
---

### Description (screenshots, logs, ...)



### Steps to reproduce

1.
2.

### Additional info

- Craft version:
- PHP version:
- Database driver & version:
- Plugins & versions:

_For some issues, we may request that you send the following items to Support <sprout@barrelstrengthdesign.com>. If you feel your issue may fall in that category, feel free to send things over after you post this issue and reference the issue in your email._

- `composer.json`
- `storage/logs/web.log` (or a zip of the whole log folder)
- An export of your database (or, if you can't share the whole db, the specific Sprout tables)
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,15 @@
---
name: Feature request
about: Suggest an idea for a new feature
---

### The problem (description, use case, screenshots...)



### The solution (that feature you'd like to see)



### Alternatives you've considered

3 changes: 3 additions & 0 deletions .github/SECURITY.md
@@ -0,0 +1,3 @@
# Security Policy

Please see the [Security](https://sprout.barrelstrengthdesign.com/docs/support/security.html) page in our documentation for details on our security policy and reporting security issues.
3 changes: 3 additions & 0 deletions .github/SUPPORT.md
@@ -0,0 +1,3 @@
# Support

Please see the [Support](https://sprout.barrelstrengthdesign.com/docs/support/support.html) page in our documentation for details on receiving support.
79 changes: 5 additions & 74 deletions README.md
Expand Up @@ -4,80 +4,11 @@ Allow users to subscribe to, follow, or like any Element including Entries, Cate

Use Sprout Lists with Sprout Email for powerful email list management and dynamic notification emails.

## Usage

Example Subscribe and Unsubscribe for Craft Users with a User ID:

``` twig
{% set params = {
listHandle: 'listHandle',
userId: currentUser.id,
elementId: entry.id,
} %}
{# Check if a user is subscribed already #}
{% if craft.sproutLists.isSubscribed(params) %}
{# Unsubscribe a user from a specific List #}
<form method="post" accept-charset="utf-8">
{{ csrfInput() }}
<input type="hidden" name="action" value="sprout-lists/lists/unsubscribe">
<input type="hidden" name="listHandle" value="listHandle">
<input type="hidden" name="elementId" value="{{ entry.id }}">
<input type="hidden" name="userId" value="{{ currentUser.id }}">
<input type="submit" value="Remove from List">
</form>
{% else %}
{# Subscribe a user to a specific List #}
<form method="post" accept-charset="utf-8">
{{ csrfInput() }}
<input type="hidden" name="action" value="sprout-lists/lists/subscribe">
<input type="hidden" name="listHandle" value="listHandle">
<input type="hidden" name="elementId" value="{{ entry.id }}">
<input type="hidden" name="userId" value="{{ currentUser.id }}">
<input type="submit" value="Add to List">
</form>
{% endif %}
```

Example Subscribe and Unsubscribe for Guests using an email address:

``` twig
{# Allow a user to submit their email to unsubscribe from a specific List #}
<form method="post" accept-charset="utf-8">
{{ csrfInput() }}
<input type="hidden" name="action" value="sprout-lists/lists/unsubscribe">
<input type="hidden" name="listHandle" value="listHandle">
<input type="hidden" name="elementId" value="{{ entry.id }}">
<input type="email" name="email" value="username@website.com">
<input type="submit" value="Remove from List">
</form>
{# Allow a user to submit their email to subscribe from a specific List #}
<form method="post" accept-charset="utf-8">
{{ csrfInput() }}
<input type="hidden" name="action" value="sprout-lists/lists/subscribe">
<input type="hidden" name="listHandle" value="listHandle">
<input type="hidden" name="elementId" value="{{ entry.id }}">
<input type="email" name="email" value="username@website.com">
<input type="submit" value="Add to List">
</form>
```

See the documentation for additional template tags and use cases.

## Documentation

See the [Sprout Website](https://sprout.barrelstrengthdesign.com/craft-plugins/lists/docs) for documentation, guides, and additional resources.

## Support

- [Send a Support Ticket](https://sprout.barrelstrengthdesign.com/craft-plugins/request/support) via the Sprout Website.
- [Create an issue](https://github.com/barrelstrength/craft-sprout-lists/issues) on Github.
- [Documentation](https://sprout.barrelstrengthdesign.com/docs/lists/)
- [Craft Plugin Store](https://plugins.craftcms.com/sprout-lists)
- [Open an Issue](https://github.com/barrelstrength/craft-sprout-lists/issues)
- [Contact Support](https://sprout.barrelstrengthdesign.com/docs/support/support.html)

<a href="https://sprout.barrelstrengthdesign.com" target="_blank">
<img src="https://s3.amazonaws.com/sprout.barrelstrengthdesign.com-assets/content/plugins/sprout-icon.svg" width="72" align="right">
<img src="https://s3.amazonaws.com/sprout.barrelstrengthdesign.com-assets/content/plugins/sprout-icon.svg" width="72" height="72" align="right">
</a>
7 changes: 2 additions & 5 deletions composer.json
Expand Up @@ -21,7 +21,7 @@
"email": "sprout@barrelstrengthdesign.com",
"issues": "https://github.com/barrelstrength/sprout-lists/issues?state=open",
"source": "https://github.com/barrelstrength/sprout-lists",
"docs": "https://sprout.barrelstrengthdesign.com/craft-plugins/email/docs",
"docs": "https://sprout.barrelstrengthdesign.com/docs/lists",
"rss": "https://github.com/barrelstrength/sprout-lists/commits/v2.atom"
},
"require": {
Expand All @@ -38,10 +38,7 @@
"name": "Sprout Lists",
"handle": "sprout-lists",
"developer": "Barrel Strength",
"developerUrl": "https://barrelstrengthdesign.com",
"documentationUrl": "https://sprout.barrelstrengthdesign.com/craft-plugins/lists",
"changelogUrl": "https://raw.githubusercontent.com/BarrelStrength/sprout-lists/master/CHANGELOG.md",
"downloadUrl": "https://github.com/BarrelStrength/sprout-lists/archive/master.zip",
"documentationUrl": "https://sprout.barrelstrengthdesign.com/docs/lists",
"class": "barrelstrength\\sproutlists\\SproutLists"
}
}

0 comments on commit 2c48e2a

Please sign in to comment.