bnadlerjr/skillmatch

View on GitHub
README.rdoc

Summary

Maintainability
Test Coverage
= Skillmatch
{<img src="https://gemnasium.com/bnadlerjr/skillmatch.png" alt="Dependency Status" />}[https://gemnasium.com/bnadlerjr/skillmatch]
{<img src="https://travis-ci.org/bnadlerjr/skillmatch.png?branch=master" alt="Build Status" />}[https://travis-ci.org/bnadlerjr/skillmatch]
{<img src="https://codeclimate.com/github/bnadlerjr/skillmatch.png" alt="Code Climate" />}[https://codeclimate.com/github/bnadlerjr/skillmatch]

Demo Sinatra app that shows integration with the LinkedIn API. Relies on the
{linkedin gem}[https://rubygems.org/gems/linkedin]. Allows you to search
through your LinkedIn connections looking for connections that have skills
related to your search term. A working example can be found at
http://skillmatch.herokuapp.com

Since this is just a demo, the search algorithm is *very* naive; it uses the
Jaro Winkler method provided by the {amatch gem}[https://rubygems.org/gems/amatch].

Author:: Bob Nadler, Jr. (bnadlerjr@gmail.com)

== Notes / Use
Install dependencies using Bundler:
    bundle install

Run using rackup file, for example:
    rackup config.ru

== Contributing

=== Issues / Roadmap
* Search algorithm is naive.

Use GitHub issues[http://github.com/bnadlerjr/skillmatch/issues] for reporting bug and feature requests.

=== Patches / Pull Requests
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don’t break it in a future version
  unintentionally.
* Commit, do not mess with rakefile, version, or history (if you want to have
  your own version, that is fine but bump version in a commit by itself I can
  ignore when I pull).
* Send me a pull request. Bonus points for topic branches.

=== Project Layout
/lib::
    Main project source code.

/test::
    All test source code and data samples.

config.ru::
    Rackup file.

Gemfile::
    Dependency management with Bundler.

Rakefile::
    Rake tasks for the project. Use "rake -T" to see a list of available tasks.

README.rdoc::
    This file.

== License
(The MIT License)

Copyright (c) 2012-2016 Bob Nadler, Jr.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.