0
I Use This!
Activity Not Available

Project Summary

Fathomer is a highly customizable tool that detects if a visitor to your site is a Twitter user and shows a badge, or ad, with your message and a link to your Twitter account.

The idea behind Fathomer is to directly target users who are already Twitter members. The thinking behind this is that existing users are much, much more likely to follow you than people who have never encountered Twitter before.

It works by detecting if a user has visited the account settings page on Twitter, which is a URL you can only access once you have been logged in to the service. The user does not have to enter any personal account information, nor do you.

Its easy to install on your site, simply by adding a small piece of javascript somewhere on your page.

It is possible to customize Fathomer in the following ways:

Custom message - A default is used if none is set. Specify your account name. This is the only required piece of information and is used for display purposes only. Custom CSS and badge html - A complete default badge comes installed. Its possible to customize the CSS and even make your own html for the badge. Change detection url - You can change the Twitter url that is being checked if you need to. Target badge placement - By default, the badge loads in the top-right corner of the browser. However this can be changed to whatever load in whatever html element you want.

REQUIREMENTS AND NOTICES:

Fathomer is written in jQuery. If your site already uses the jQuery library, it works just fine. However, if Fathomer doesn't find jQuery, it will dynamically load it into the browser.

You have to configure your Twitter username in the script. There's no way to guess, so if you don't want to publish your Twitter account then why are you using Fathomer?
HOW TO USE

Paste this code into your page. Customize the different parameters by uncommenting them and modifying them.

// Required. Your account name.
fathomer.account = 'yourAccountName';

// Optional. The message that is displayed.
//fathomer.message = 'Sample override message.';

// Optional. Can specify a specific element to attach to. ID, class, or css selector
//fathomer.target = '';

// Optional. Turn off default css if you have your own styles.
//fathomer.loadcss = false;

// Optional. Can be changed to a different Twitter url to check the visited history state.
//fathomer.urlcheck = '';

// Optional. If a custom html structure is needed, it can be loaded using standard jquery methods in altbadge. Properties are accessed/set via fathomer.var, e.g. fathomer.message.
//fathomer.altbadge = function(){};

fathomer.init();

HOW IT BEHAVES

Here's the matrix of rules that happen that determine if Fathomer shows or not. When a user closes the badge, a cookie is set so as not to show it again.

Not visited fathomer.urlcheck + No cookie = NO SHOW Not visited fathomer.urlcheck + Cookie = NO SHOW Visited fathomer.urlcheck + No cookie = SHOW!! (basically this means its very likely the user is a Twitter member) Visited fathomer.urlcheck + Cookie = NO SHOW!! (the user has seen the badge and closed it)

Tags

javascript twitter

In a Nutshell, fathomer...

 No code available to analyze

Open Hub computes statistics on FOSS projects by examining source code and commit history in source code management systems. This project has no code locations, and so Open Hub cannot perform this analysis

Is this project's source code hosted in a publicly available repository? Do you know the URL? If you do, click the button below and tell us so that Open Hub can generate statistics! It's fast and easy - try it and see!

Add a code location

MIT License
Permitted

Commercial Use

Modify

Distribute

Private Use

Sub-License

Forbidden

Hold Liable

Required

Include Copyright

Include License

These details are provided for information only. No information here is legal advice and should not be used as such.

All Licenses

This Project has No vulnerabilities Reported Against it

Did You Know...

  • ...
    Black Duck offers a free trial so you can discover if there are open source vulnerabilities in your code
  • ...
    data presented on the Open Hub is available through our API
  • ...
    there are over 3,000 projects on the Open Hub with security vulnerabilities reported against them
  • ...
    by exploring contributors within projects, you can view details on every commit they have made to that project

 No code available to analyze

Open Hub computes statistics on FOSS projects by examining source code and commit history in source code management systems. This project has no code locations, and so Open Hub cannot perform this analysis

Is this project's source code hosted in a publicly available repository? Do you know the URL? If you do, click the button below and tell us so that Open Hub can generate statistics! It's fast and easy - try it and see!

Add a code location

Community Rating

Be the first to rate this project
Click to add your rating
   Spinner
Review this Project!
Sample ohloh analysis