Merge pull request #1 from Javid-Izadfar/master

Add Pol files

Author: setare karimi

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing to Pol
+Want to make Pol better? These are ways you can contribute:
+
+## Ask for new media
+Though Pol is free and open source, we have to follow some certain standards. If you want us to add a new media, please have this things in mind:
+* Search [previous icon requests](https://github.com/IKAcc/Pol/search?type=Issues) to see if your wanted media already exists. If it was requested before, +1 it.
+* Ask for a single media at a request.
+* Make sure that media is notable enough.
+* Title your new issue Icon request: `add: media_name` (e.g., Icon request: `add: Twitter`).
+
+## Report a bug
+We can’t claim that Pol is bug free. Please be kind and report issues in the following manner:
+* Search in existing issues. We don’t want to get hundreds of duplicated reports. There are even chances that we are already working on that issue you’re facing.
+* Try to reproduce issue. Make sure that issue is made up by Pol Icons and not with your other components with a [reduced test case](https://css-tricks.com/reduced-test-cases/).
+* Include an example. We can fix bugs much faster if we could lay an eye upon it.
+
+## Code CSS
+Please follow these standards if you want to change some CSS:
+* Multiple-line approach (one property and value per line).
+* Always a space after a property's colon (.e.g, `font=size: 2rem;` and not `font-size:2rem;`).
+* End all lines with a semi-colon.
+* For multiple, comma-separated selectors, place each selector on its own line.
+
+Note: By contributing in codes, you agree to license your contribution under the terms of the [MIT License](https://opensource.org/licenses/mit-license.html).
+
+## Support us
+If you like to support us as an sponsor, please contact [email protected]

README.md

@@ -1 +1,79 @@
-# Pol
+# Pol
+[![](http://ikacc.ir/github-assets/pol-header-v1.0.png)](https://github.com/IKAcc/Pol)
+
+Pol (Farsi: پل, "Bridge") is a new way for your audience to share contents of your site. You - as a Content Manager (CM) - point out to the most important part of your content, then Pol will transform it to a shareable link using javaScript and CSS so anyone could share it on your targeted social network.
+
+Pol is created by [Javid Izadfar](https://twitter.com/JavidIzadfar "Javid Izadfar at Twitter") and [Setareh Karimi](https://twitter.com/setarekarimi "Setareh Karimi at Twitter") at [IKA Computing Club](http://ikacc.ir/) as a [free and open-source tool](../master/LICENSE); so feel free to use and modify it as you need.
+
+Pol will look great, using [Gorbeh](https://github.com/IKAcc/Gorbeh-Icons) for media icons and [RangeBrand](https://github.com/IKAcc/RangeBrand) for official media colors.
+
+## License
+Pol files are licensed under the MIT License:
+* https://opensource.org/licenses/mit-license.html
+
+## Contributing
+We support and encourage any kind of contribution by anyone. Please read through [contributing guidelines](../master/CONTRIBUTING.md). In these guidelines, directions to asking for a new media, reporting a bug and other notes are fully explained.
+
+## Supporting Media
+Pol currently supports the following social networks:
+* Telegram
+* Twitter
+
+## Usage
+To use Pol on your site or blog, follow these steps:
+
+1) Download Pol’s [latest release](../zipball/master).
+
+2) Add Pol folder to your preferred directory on your project.
+
+3) Add Pol.js to your HTML file:
+```html
+<!-- Pol js -->
+    <script src="js/pol.js"></script>
+```
+  or
+```html
+<!-- Pol min.js -->
+    <script src="js/pol.min.js"></script>
+```
+
+4) Add Pol.css to your HTML file (Optional):
+```html
+<!-- Pol css -->
+  <link href="css/pol.css" rel="stylesheet">
+```
+  or
+```html
+<!-- Pol min.css -->
+    <link href="css/pol.min.css" rel="stylesheet">
+```
+
+5) Initiate Pol in your custom js file:
+```javascript
+$('body').pol()
+```
+see [Options](#Options) for more initialization options.
+
+6) Implement a Pol, using `data-pol-media` and name your preferred media:
+```html
+<span data-pol-media="twitter"> .... </span>
+```
+## Options
+| Option        | Default value          | Functionality          |
+| ------------- |:----------------------:| :----------------------|
+| url           | current page's URL     | Includes a link to the source |
+| target        | _blank                 | How should Pol's link behave when is clicked |
+| author        | none                   | Your official account(s) on targeted media. do NOT include "@". Separate accounts using ",". |
+| hashtags      | none                   | Hashtags. do NOT include "#". Separate accounts using ",". |
+
+## Creators
+* ![](https://avatars3.githubusercontent.com/u/14288838?v=3&s=16) Javid Izadfar
+  * Email: [email protected]
+  * Twitter: [twitter.com/JavidIzadfar](http://twitter.com/JavidIzadfar)
+  * Github: [github.com/Javid-Izadfar](http://github.com/Javid-Izadfar)
+* ![](https://avatars3.githubusercontent.com/u/13146837?v=3&s=16) Setareh Karimi
+  * Email: [email protected]
+  * Twitter: [twitter.com/setarekarimi](http://twitter.com/setarekarimi)
+  * Github: [github.com/setarek](http://github.com/setarek)
+
+[![IKA Computing Club](http://ikacc.ir/github-assets/ika-footer.png)](http://ikacc.ir)

css/pol.css

@@ -0,0 +1,22 @@
+/*
+	Pol
+	Created by @JavidIzadfar and @setarekarimi at IKAcc
+	Last edit on June 11, 2016
+*/
+
+a[data-pol-media]{
+  outline: none;
+  color: inherit;
+  text-decoration: none;
+  -webkit-transition: all 0.2s ease-out;
+     -moz-transition: all 0.2s ease-out;
+       -o-transition: all 0.2s ease-out;
+          transition: all 0.2s ease-out;}
+
+a[data-pol-media="twitter"]:hover{
+  background-color: rgba(85, 172, 238, .1);
+}
+
+a[data-pol-media="telegram"]:hover{
+  background-color: rgba(0, 136, 204, .1);
+}

css/pol.min.css

@@ -0,0 +1,7 @@
+/*
+	Pol
+	Created by @JavidIzadfar and @setarekarimi at IKAcc
+	Last edit on June 11, 2016
+*/
+
+a[data-pol-media]{outline:none;color:inherit;text-decoration:none;-webkit-transition:all .2s ease-out;-moz-transition:all .2s ease-out;-o-transition:all .2s ease-out;transition:all .2s ease-out}a[data-pol-media="twitter"]:hover{background-color:rgba(85,172,238,.1)}a[data-pol-media="telegram"]:hover{background-color:rgba(0,136,204,.1)}

js/pol.js

@@ -0,0 +1,94 @@
+/*
+	Pol
+	Created by @JavidIzadfar and @setarekarimi at IKAcc
+	Last edit on June 11, 2016
+*/
+
+(function( $ ) {
+
+    $.fn.pol = function(options) {
+
+      var settings = $.extend({ // These are the defaults.
+          url:      $(location).attr('href'), // by default, use current URL
+          target:   '_blank', // by default, link opens in new blank tab
+          author:   '', // by default, no author
+          hashtags: '', // by default, no author
+      }, options );
+
+      var authorActive = '';
+      var hashtagsActive = '';
+
+      if (settings.author) authorActive = '%40' + settings.author.replace(/, |,/g, "%20%40"); // turn author to an active user(s)
+      if (settings.hashtags) hashtagsActive = '%23' + settings.hashtags.replace(/, |,/g, "%20%23"); // turn author to an active tags(s)
+
+      var media = [
+        // { // Twitter (Official)
+        //   name:           'twitter',
+        //   baseURL:        'https://twitter.com/intent/tweet?',
+        //   textBinding:    '&text=',
+        //   hashtagBinding: '&hashtags=',
+        //   viaBinding:     '&via=',
+        //   urlBinding:     '&url=',
+        //   requireActive:  false
+        // },
+        { // Twitter (Unofficial)
+          name:           'Twitter',
+          baseURL:        'https://twitter.com/intent/tweet?',
+          textBinding:    '&text=',
+          hashtagBinding: '%0A',
+          viaBinding:     '%0A',
+          urlBinding:     '&url=',
+          requireActive:  true
+        },
+        { // Telegram
+          name:           'Telegram',
+          baseURL:        'https://telegram.me/share/url?',
+          textBinding:    '&text=',
+          hashtagBinding: '%0A',
+          viaBinding:     '%0A',
+          urlBinding:     '&url=',
+          requireActive:  true
+        }
+      ]
+
+      $('[data-pol-media]').each(function(){ // get every Pol
+
+        var attrs = {
+          text:   $(this).text(), // Pol's content
+          html:   $(this).html(), // Pol's content + HTML
+          target: settings.target, // Pol's targeting behavior
+        };
+
+        $.each(this.attributes, function() { // get all other attributes
+          if(this.specified) {
+            attrs[this.name] = this.value; // and save on attrs object
+          }
+        });
+
+        for (var i = 0; i < media.length; i++) { // check media array to
+          if (attrs['data-pol-media'].toLowerCase() == media[i].name.toLowerCase()) { // grab the pol-media object
+
+            if (!settings.hashtags) media[i].hashtagBinding = ''; // remove the hashtags's binding if hashtag(s) is not specified
+            if (!settings.author)   media[i].viaBinding     = ''; // remove the author's binding if author(s) is not specified
+
+            if (media[i].requireActive) { // if media required active links
+              settings.hashtags = hashtagsActive;  // active hashtags(s)
+              settings.author   = authorActive;    // active author(s)
+            }
+
+            attrs.title = 'Share on ' + media[i].name; // Pol's title for link
+
+            attrs.href = media[i].baseURL + media[i].textBinding + attrs.text + media[i].hashtagBinding + settings.hashtags + media[i].viaBinding + settings.author + media[i].urlBinding + settings.url; // the universal Pol URL
+
+          }
+        }
+
+        $(this).replaceWith(function () { // replace span with <a> tag
+          return $("<a />", attrs); // with its attributes
+        });
+
+      });
+
+    };
+
+}( jQuery ));