docs: Add supported formats to the readme

2024-05-10 19:30:22 +02:00 · 2024-05-10 19:30:22 +02:00 · 380968a5d7
parent d9c921ef9c
commit 380968a5d7
1 changed files with 11 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -1,4 +1,13 @@
 # numf

-This is just a trivial program that format's it's arguments in binary, hex or
-octal.
+`numf` is a number formatter. It formats the numbers provided to it.
+
+Current formats are:
+
+- Hexadecimal
+- Binary
+- Octal
+- Decimal
+
+`numf` also has the option of prepending a prefix for each format, such as
+`0x` for hexadecimal.