initial commit

[squeep-roman] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..e837542
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# @squeep/roman
+
+## What
+
+Render numbers as their Roman equivalents, using Unicode characters by default, or those converted to HTML encoded entities.
+
+## Why
+
+These code points exist, so we might as well use them and feel all fancy about our copyright footers.
+
+## API
+
+`toRoman(num, asEntities = false)`