Skip to content

Commit

Permalink
Merge branch 'release/3.1.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
compeak committed Jan 29, 2019
2 parents 6d71c7c + a704807 commit d07a66a
Show file tree
Hide file tree
Showing 19 changed files with 5,638 additions and 4,322 deletions.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!--
Please check:
- [ ] Your pull request has a meaningful title.
- [ ] The description explains the changes proposed by the pull request and why you believe they are necessary.
- [ ] Relevant issues and pull requests are mentioned.
- [ ] The pull request contains documentation in README.md/README-de.md if necessary.
- [ ] You did not include any build artifacts.

Delete this list before submitting. Pull requests containing the list or failing to check all points will be rejected.
-->
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ env:
global:
- BASE_NAME=shariff-$TRAVIS_TAG

cache:
directories:
- node_modules

script:
- npm run test

Expand Down
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Changelog

## v3.1.0, 2019-01-29

- Added Pocket service. (richard67)
- Improved build process. (DanielRuf)
- Replaced third party Java backend in readme. (shred)
- Upgraded dependencies.
- Fixed creator being appended to title even though `data-title` has been set. (ksuess)
- Fixed canonical URL handling. (OliverFriedrich)
- Fixed typo in README. (richard67)

This release removes a service:

- Removed G+ service. (richard67)

## v3.0.1, 2018-04-17

- Added Yellow CMS third party integration. (so-ri)
Expand Down
10 changes: 5 additions & 5 deletions README-de.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Um die Privatsphäre ihrer Besucher gegenüber den Social-Media-Netzwerken zu be

![Shariff Logo © 2015 Heise Medien](http://www.heise.de/icons/ho/shariff-logo.png)

Der Code der offiziellen Buttons von Facebook, Google+ und Twitter überträgt von jedem Besucher kennzeichnende Daten an die Social-Media-Netzwerke. Shariff erzeugt hingegen Share-Buttons, die mit einem Klick teilen, die Anzahl der Likes und Plus-Ones für die aktuelle Seite anzeigen und trotzdem keine unnötigen Daten übertragen.
Der Code der offiziellen Buttons beispielsweise von Facebook überträgt von jedem Besucher kennzeichnende Daten an die Social-Media-Netzwerke. Shariff erzeugt hingegen Share-Buttons, die mit einem Klick teilen, die Anzahl der Likes und Plus-Ones für die aktuelle Seite anzeigen und trotzdem keine unnötigen Daten übertragen.

Shariff `(/ˈʃɛɹɪf/)` ist ein Open-Source Projekt von c't und heise online.

Expand Down Expand Up @@ -98,7 +98,7 @@ $ npm run dev
| `data-media-url` | Zu teilendes Bild (pinterest) | `null` |
| `data-orientation` | Anordnung der Buttons. Verfügbar: `horizontal`, `vertical` | `horizontal` |
| `data-referrer-track` | Wenn angegeben, wird dieser String an die geteilte URL angehängt. Mit `null` deaktivieren. | `null` |
| `data-services` | Liste der Services, die verwendet werden sollen. Für die Verwendung im `data`-Attribut muss die Angabe Entity-enkodiert werden. Die Reihenfolge wird berücksichtigt. Beispiel: `data-services="[&quot;facebook&quot;,&quot;googleplus&quot;]"` <br> Verfügbare Dienste: `twitter`, `facebook`, `googleplus`, `linkedin`, `pinterest`, `xing`, `whatsapp`, `mail`, `info`, `addthis`, `tumblr`, `flattr`, `diaspora`, `reddit`, `stumbleupon`, `threema`, `weibo`, `tencent-weibo`, `qzone`, `print`, `telegram`, `vk`, `flipboard` | `twitter`, `facebook`, `googleplus`, `info` |
| `data-services` | Liste der Services, die verwendet werden sollen. Für die Verwendung im `data`-Attribut muss die Angabe Entity-enkodiert werden. Die Reihenfolge wird berücksichtigt. Beispiel: `data-services="[&quot;facebook&quot;,&quot;twitter&quot;]"` <br> Verfügbare Dienste: `twitter`, `facebook`, `linkedin`, `pinterest`, `xing`, `whatsapp`, `mail`, `info`, `addthis`, `tumblr`, `flattr`, `diaspora`, `reddit`, `stumbleupon`, `threema`, `weibo`, `tencent-weibo`, `qzone`, `print`, `telegram`, `vk`, `flipboard`, `pocket` | `twitter`, `facebook`, `info` |
| `data-theme` | Farbschema auswählen. Verfügbar: `standard`, `grey` und `white`. | `standard` |
| `data-title` | Titel der zu teilenden Seite. | Entweder `DC.title`/`DC.creator` oder `<title>` |
| `data-twitter-via` | User von dem der Tweet ursprünglich stammt. | `null` |
Expand Down Expand Up @@ -137,10 +137,10 @@ Shariff unterstützt folgende Social-Sharing-Services:
- facebook
- Flattr
- Flipboard
- Google+
- LinkedIn
- Mail
- Pinterest
- Pocket
- Print
- Qzone
- reddit
Expand All @@ -166,7 +166,7 @@ Wenn in den Shariff-Buttons die Share-Counts angezeigt werden sollen, wird das f

Drittanbieter-Backends:

* [shariff-backend-java](http://github.com/headissue/shariff-backend-java)
* [shariff-backend-java](https://github.com/shred/shariff-backend-java)

Die URL, unter der das Backend erreichbar ist, muss im `data`-Attribut `data-backend-url` angegeben werden. Ein Backend unter der URL `http://example.com/my-shariff-backend/` wird in `data-backend-url` so angegeben: `/my-shariff-backend/`. Den Rest erledigt das Skript.

Expand All @@ -189,4 +189,4 @@ Bekannte Shariff-Integrationen für Drittanbieter-Systeme:
* [WordPress-Plugin Shariff Wrapper](https://wordpress.org/plugins/shariff/)
* [Xenforo [ITM] ctSSB für Xenforo 1.5](https://github.com/McAtze/-ITM-ctShariffSocialButtons)
* [Xenforo [WMTech] Social Share Privacy Plugin](https://wmtech.net/products/wmtech-social-share-privacy.41/)
* [Yellow Plugin Shariff](https://github.com/schulle4u/yellow-plugin-shariff)
* [Magento 2 Shariff Social Share](https://www.jajuma.de/de/jajuma-develop/extensions/shariff-social-share-buttons-extension-fuer-magento-2)
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Shariff enables website users to share their favorite content without compromisi

![Shariff Logo © 2015 Heise Medien](http://www.heise.de/icons/ho/shariff-logo.png)

Facebook, Google+ and Twitter supply official sharing code snippets which quietly siphon personal data from all page visitors. Shariff enables visitors to see how popular your page is on Facebook and share your content with others without needless data leaks.
Some social service providers like e.g. Facebook supply official sharing code snippets which quietly siphon personal data from all page visitors. Shariff enables visitors to see how popular your page is on Facebook and share your content with others without needless data leaks.

Shariff `(/ˈʃɛɹɪf/)` is an open-source, low-maintenance, high-privacy solution maintained by German computer magazine c't and heise online.

Expand Down Expand Up @@ -99,7 +99,7 @@ $ npm run dev
| `data-media-url` | Media url to be shared (pinterest) | `null` |
| `data-orientation` | `vertical` will stack the buttons vertically. | `horizontal` |
| `data-referrer-track` | A string that will be appended to the share url. Can be disabled using `null`. | `null` |
| `data-services` | An entity-encoded JSON string containing an array of service names to be enabled. Example: `data-services="[&quot;facebook&quot;,&quot;googleplus&quot;]"` Available service names: `twitter`, `facebook`, `googleplus`, `linkedin`, `pinterest`, `xing`, `whatsapp`, `mail`, `info`, `addthis`, `tumblr`, `flattr`, `diaspora`, `reddit`, `stumbleupon`, `threema`, `weibo`, `tencent-weibo`, `qzone`, `print`, `telegram`, `vk`, `flipboard` | `twitter`, `facebook`, `googleplus`, `info` |
| `data-services` | An entity-encoded JSON string containing an array of service names to be enabled. Example: `data-services="[&quot;facebook&quot;,&quot;twitter&quot;]"` Available service names: `twitter`, `facebook`, `linkedin`, `pinterest`, `xing`, `whatsapp`, `mail`, `info`, `addthis`, `tumblr`, `flattr`, `diaspora`, `reddit`, `stumbleupon`, `threema`, `weibo`, `tencent-weibo`, `qzone`, `print`, `telegram`, `vk`, `flipboard`, `pocket` | `twitter`, `facebook`, `info` |
| `data-theme` | We include 3 color schemes, `standard`, `grey` and `white`. | `standard` |
| `data-title` | Title to be used as share text in Twitter/Whatsapp | page's `DC.title`/`DC.creator` or `<title>` |
| `data-twitter-via` | Screen name of the user to attribute the Tweet to | `null` |
Expand Down Expand Up @@ -139,10 +139,10 @@ Shariff supports the following social sharing services:
- facebook
- Flattr
- Flipboard
- Google+
- LinkedIn
- Mail
- Pinterest
- Pocket
- Print
- Qzone
- reddit
Expand All @@ -158,7 +158,7 @@ Shariff supports the following social sharing services:
- XING

In addition, the service `Info` provides a button to show an info page about the social sharing buttons.
The URL of this page can be set with an option. Default value: `http://ct.de/-2467514`, i.e. the c't article introducing Shariff.
The URL of this page can be set with an option. Default value: `http://ct.de/-2467514`, i.e. the c't article introducing Shariff.

## Backends

Expand All @@ -168,7 +168,7 @@ In order to display share counts with Shariff, you need the following backend:

Third-party backends:

* [shariff-backend-java](http://github.com/headissue/shariff-backend-java)
* [shariff-backend-java](https://github.com/shred/shariff-backend-java)

Once you have one of these backends up and running, insert its URL into the `data-backend-url` attribute. For example, if the backend runs under `http://example.com/my-shariff-backend/`, the `data-backend-url` should be `/my-shariff-backend/`. The script will handle the rest.

Expand All @@ -191,4 +191,4 @@ This is a list of integrations for third-party systems:
* [WordPress Plugin Shariff Wrapper](https://wordpress.org/plugins/shariff/)
* [Xenforo [ITM] ctSSB for Xenforo 1.5](https://github.com/McAtze/-ITM-ctShariffSocialButtons)
* [Xenforo [WMTech] Social Share Privacy Plugin](https://wmtech.net/products/wmtech-social-share-privacy.41/)
* [Yellow Plugin Shariff](https://github.com/schulle4u/yellow-plugin-shariff)
* [Magento 2 Shariff Social Share](https://www.jajuma.de/en/jajuma-develop/extensions/shariff-social-share-buttons-extension-for-magento-2)
4 changes: 3 additions & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ To prepare a release you have to do the following tasks:
1. Run `git flow release start [version]`.
2. Bump versions in `package.json`.
3. Update [CHANGELOG.md](CHANGELOG.md).
2. Run `git flow release finish`.
4. Run `npm install` to update `package-lock.json`.
5. Commit changes.
6. Run `git flow release finish`.

After pushing the release tag to GitHub, Travis CI will create release downloads and push the release to [npmjs.com](https://www.npmjs.com).

Expand Down
2 changes: 1 addition & 1 deletion demo/custom-initialization.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
// Set custom options in constructor
new Shariff(createDiv(), {
theme: "grey",
services: ["twitter", "googleplus"],
services: ["twitter", "facebook"],
infoUrl: "http://www.example.com"
});
</script>
Expand Down
Loading

0 comments on commit d07a66a

Please sign in to comment.