README.md edited online with Bitbucket

Author: felipexw

README.md

@@ -2,19 +2,27 @@
 
 ### What is this repository for? ###
 
-* Quick summary
-* Version
-* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
+* Its a very simple implementation of K-Nearest Neighbor algorithm for Supervide Learning (user labeled data)
+* Version 1.0
 
-### How do I get set up? ###
+### Features presents ###
 
-* Summary of set up
-* Configuration
-* Dependencies
-* Database configuration
-* How to run tests
-* Deployment instructions
+* The following similarities metrics are presents:
+- Euclidian Distance
+- Jaccard Distance
+- Pearson Correlation
+- Cosine Distance
+- Minkowski Distance (to be done)
+- Manhattan Distance (to be done)
+- Mahalanobis Distance (to be done)
+* A naive knn implementation with (or without) k-fold cross-validation.
 
-### Contribution guidelines ###
+### How to use ###
 
-* For the project and submit a pull request
+* Just clone the project
+* Setup your project
+* Init a SimpleKNNClassifier
+* Inject the SimilarityCalculator of your choice into SimpleKNNClassifier instance
+* Fit with some labeled data
+* Train the classifier (you can choose if you want to train using k-fold cross validation or not)
+* Pass some data to predict() method and see the label predicted