readme

1 files changed, 13 insertions, 10 deletions

diff --git a/README.md b/README.md
index 018621c..5d50af8 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,15 @@
-My little NLP library for ruby.
+nlp_ruby
+========
 
-dags.rb
-fileutil.rb
-PriorityQueue.rb
-semirings.rb
-SparseVector.rb
-stringutil.rb
-tfidf.rb
-ttable.rb
-Vector.rb
+My little NLP library, supposed to make _my_ work a little easier and less redundant.
+
+* dags.rb : implementation of a directed acyclic graph and various algorithms
+* fileutil.rb : file utilities
+* PriorityQueue.rb : a simple priority queue
+* semirings.rb : semirings for dags.rb
+* SparseVector.rb : sparse vectors for ruby, based on Hash
+* stringutil.rb : string utilities
+* tfidf.rb : functions to calculate tf/ntf/idf
+* ttable.rb : functions to read MT phrase tables
+* Vector.rb : vector class based on Array