Browse Source

First draft

Piotr Czajkowski 6 years ago
parent
commit
23dcb31e1f
1 changed files with 10 additions and 2 deletions
  1. 10 2
      README.md

+ 10 - 2
README.md

@@ -1,2 +1,10 @@
-# bom
-Simple library for dealing with UTF-8 BOM (Byte Order Mark)
+# BOM
+
+I've written it for fun and because BOM is still a valid problem in l10n world. It's simple and relies only on standard libraries, so should work pretty much everywhere.
+
+It contains simple test which you can run by:
+	make test
+
+It's 22 times faster than similar one I've written in C#, so either C is faster at that or I've written it better:) Enjoy!
+
+***As always, you can use it as you want, but I give you no warranty.***