Go to file
2012-02-04 15:02:11 -08:00
lib Remove old gem def 2012-02-04 14:50:39 -08:00
test Train-driven development 🚋 2012-02-04 15:02:11 -08:00
.document Initial commit to email. 2012-01-30 17:14:23 -08:00
.gitignore Initial commit to email. 2012-01-30 17:14:23 -08:00
.rbenv-version Initial commit 2012-01-30 20:01:16 -08:00
Gemfile Initial commit 2012-01-30 20:01:16 -08:00
Gemfile.lock Initial commit 2012-01-30 20:01:16 -08:00
LICENSE.txt Initial commit to email. 2012-01-30 17:14:23 -08:00
Rakefile Train-driven development 🚋 2012-02-04 14:49:09 -08:00
README.rdoc Train-driven development 🚋 2012-02-04 15:02:11 -08:00
swot.gemspec Train-driven development 🚋 2012-02-04 14:49:09 -08:00
VERSION Version bump to 0.1.0 2012-01-30 20:04:07 -08:00

Swot allows you to figure out whether a particular email address or domain
is associated with an academic institution providing higher education in
tertiary, quaternary or post-secondary education in any country in the
world.

**What is a swot?** [UrbanDictionary will fill you in](http://www.urbandictionary.com/define.php?term=swot) ಠ_ಠ

== Usage

    Swot::academic?('lreilly@stanford.edu')           # true
    Swot::academic?('lreilly@slac.stanford.edu')      # true
    Swot::academic?('lreilly@strath.ac.uk')           # true
    Swot::academic?('lreilly@soft-eng.strath.ac.uk')  # true
    Swot::academic?('lee@ugr.es')                     # true
    Swot::academic?('lee@uottawa.ca')                 # true
    Swot::academic?('harvard.edu')                    # true
    Swot::academic?('www.harvard.edu')                # true
    Swot::academic?('http://www.harvard.edu')         # true

    Swot::academic?('lee@leerilly.net')              # false
    Swot::academic?('lee@gmail.com')                 # false
    Swot::academic?('lee@stanford.edu.com')          # false
    Swot::academic?('lee@strath.ac.uk.com')          # false

* is this email address from an academic institution?

== Contributing to email

* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
* Start a feature/bugfix branch.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

== Known Issues /

* You can search by email and domain names only. You cannot search by IP.
* Can't handle port numbers yet.

![](https://a248.e.akamai.net/assets.github.com/img/e3700efc05ca611162b365367aadc8b112b4969d/687474703a2f2f692e696d6775722e636f6d2f4b387673772e676966)

== Copyright

Copyright (c) 2012 Lee Reilly. See LICENSE.txt for
further details.