GitHub - shareNice-org/shareNice: An ethical way of adding social sharing features to your website, without compromising your users' privacy by dropping tracking cookies on them.

shareNice-org / shareNice Public

Notifications You must be signed in to change notification settings
Fork 9
Star 59

An ethical way of adding social sharing features to your website, without compromising your users' privacy by dropping tracking cookies on them.

sharenice.org

MIT license

59 stars 9 forks Branches Tags Activity

Star

Notifications

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 189 Commits
gen-config		gen-config
grab-icons		grab-icons
images		images
webserver		webserver
website		website
.gitignore		.gitignore
LICENSE.txt		LICENSE.txt
README		README
code.js		code.js

Repository files navigation

Updated README file 20110514.

shareNice can now be found on http://sharenice.org/.

The software is written in order to provide social sharing features to web developers and website administrators who wish to maintain and protect their users' privacy.

The current version of the system does not rely on anything but the user having JavaScript enabled.

There are two ways which you can use shareNice on your website:

1. 	You can include the following div in your HTML '<div id="shareNice"></div>', and include the following JavaScript in your HTML header : http://sharenice.org/code.js
	'<script src="http://sharenice.org/code.js" type="text/javascript"></script>'

2. 	You can download the software from http://github.com/mischat/shareNice and you can host it on your own domain.


The demo file supplied with this repository shows how easy it is to include this XHTML-STRICT friends HTML+JS fragment to have a social sharing feature on your website.

The code you need to add to your HTML document is as simple as :
<html>
<head>
      <script src="http://sharenice.org/code.js" type="text/javascript"></script>
      <link type="text/css" rel="stylesheet" href="http://sharenice.org/main.css" />
      <!--[if IE 6]>
        <link type="text/css" rel="stylesheet" href="http://sharenice.org/ie6.css" >
      <![endif]-->
   </head>
   <body onLoad="shareNiceLoad()">
   <!-- This is the shareNice div you need to include in your HTML -->
   <div id="shareNice" style="float:left"></div>
   <!-- The rest of the magic is injected via .js -->

   </body>
</html>

Configuring the shareNice lightbox

One can now reconfigure shareNice, using the following five attributes

services: Takes a comma separate list of domain's which you are interested in including in your shareNice lightbox.
share-label: Allows a website owner to config the text "Share" as they please.
color-scheme: You can choose one of "black", "blue", "green", "orange", "pink", "red" to customise.
icon-size: either "16" or "32", this defines the size of the shareNice icon.
panel-bottom: either "default" or "plain". Where: "plain" gives a non-branded lightbox.

An example of a customised shareNice lightbox could be like so :

<div id="shareNice" color-scheme="black" icon-size="32" share-label="Share this demo" panel-bottom="plain"></div>

The .png files have been generated from the domain's favicon files, and converted using the grab-icons/snarf-icon.pl script. If you want to refresh/add more domain, you can run the perl script supplied in this repo. If you want to grab more icons, add the domain of the service to grab-icons/icon-domains.txt

In order to generate the main "code.js" file in the root directory of the repository, please "cd gen-config" and then run the "./gen-sharenice-config.pl" script.