Nicer README

github · Feb 19, 2015 · 3454bc3 · 3454bc3
1 parent 2cd0122
commit 3454bc3
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 18 deletions.
diff --git a/README.markdown b/README.markdown
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# Version sorter
+
+Fast sorting of strings representing version numbers.
+
+```rb
+require 'version_sorter'
+
+versions = ["1.0.9", "2.0", "1.0.10", "1.0.3", "2.0.pre"]
+
+VersionSorter.sort(versions)
+#=> 1.0.3
+#=> 1.0.9
+#=> 1.0.10
+#=> 2.0.pre
+#=> 2.0
+```
+
+Library API:
+
+```rb
+VersionSorter.sort(versions)   #=> sorted array
+VersionSorter.rsort(versions)  #=> reverse sorted array
+
+VersionSorter.sort!(versions)  # sort array in place
+VersionSorter.rsort!(versions) # reverse sort array in place
+```
+
+<http://github.com/blog/521-speedy-version-sorting>