Permalink
Browse files

documentation

  • Loading branch information...
1 parent ae0853b commit 78a546b0b817bf31804398f0c5ca969ab3b6dea1 @schneems committed Apr 26, 2011
Showing with 41 additions and 0 deletions.
  1. +23 −0 README.md
  2. +18 −0 license.txt
View
@@ -0,0 +1,23 @@
+Install
+-------
+ git clone git@github.com:Schneems/Potential-Friend-Finder.git
+ cd Potential-Friend-Finder
+ bundle install
+ rails s
+
+Note: require memcache and redis
+
+Use
+---
+Navigate to [http://localhost:3000](http://localhost:3000) on your computer. Create an admin account, this will allow you to add 'users' to your mini-social network. Once you have users, you can make friends, and observe what our potential friends our algorithm suggests.
+
+
+About
+-----
+Potential friend finder is a demo app for a simple version of the _People You May Know Algorithm_ used on [Gowalla](http://gowalla.com). You can check out the real-algorithm in-action on the web by signing up for a [Gowalla](http://gowalla.com) account and adding friends. For more information please check out the source code, and i'll post a link to the slides that discuss this code in the future.
+
+Please fork this project, and see if you can come up with improvements to the algorithm. If you want me to pull your fork later, please make your changes on a branch, and give the user some way to toggle between your algorithm and the original algorithm.
+
+If you want to contribute and you need to reach me, you can find me on the twitters @schneems
+
+Copyright (c) 2011 Schneems
View
@@ -0,0 +1,18 @@
+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.

0 comments on commit 78a546b

Please sign in to comment.