aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorJosef Pospíšil <josef.pospisil@laststar.eu>2020-05-22 09:50:33 +0200
committerJosef Pospíšil <josef.pospisil@laststar.eu>2020-05-22 09:50:33 +0200
commita17c71edcb9f76c9f571dc6ad4d10151bc7de038 (patch)
tree4dc639339a55c091a259e20dbcc56eacbfeab217 /README.md
parentExtend netrepl protocol and server. (diff)
Add formatting to the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 56c7194..038485b 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,28 @@
Various Janet utility modules.
+
+## Formatting
+
+Provides a way to format Janet code strings and files.
+
+### Strings
+
+```
+(import spork/fmt)
+
+(fmt/format "(def a\n 3 )") => @"(def a\n 3)\n"
+
+```
+
+### Files
+
+```
+(import spork/fmt)
+
+(fmt/format-file "main.janet")
+```
+
## Message Protocol
Provide a symmetric way to send and receive seqential messages over a networked stream.