aboutsummaryrefslogtreecommitdiff
path: root/aoc2023/build/packages/simplifile/README.md
diff options
context:
space:
mode:
authorJ.J <thechairman@thechairman.info>2024-05-30 21:50:02 -0400
committerJ.J <thechairman@thechairman.info>2024-05-30 21:50:02 -0400
commit612fd986ab1e00b6d34dc1937136250e08e89325 (patch)
treea3c93952040c6afdf348b5831619a45db7ba0a2e /aoc2023/build/packages/simplifile/README.md
parent231c2b688d1e6cf0846d46e883da30e042a9c6cf (diff)
downloadgleam_aoc-612fd986ab1e00b6d34dc1937136250e08e89325.tar.gz
gleam_aoc-612fd986ab1e00b6d34dc1937136250e08e89325.zip
cleanup
Diffstat (limited to 'aoc2023/build/packages/simplifile/README.md')
-rw-r--r--aoc2023/build/packages/simplifile/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/aoc2023/build/packages/simplifile/README.md b/aoc2023/build/packages/simplifile/README.md
new file mode 100644
index 0000000..5e49113
--- /dev/null
+++ b/aoc2023/build/packages/simplifile/README.md
@@ -0,0 +1,29 @@
+# simplifile
+
+[![Package Version](https://img.shields.io/hexpm/v/simplifile)](https://hex.pm/packages/simplifile)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/simplifile/)
+
+Simplifile provides basic file operations (read, write, append, and delete) that work
+for all targets (Erlang, Node, and Deno). It also provides functions for working with directories.
+
+Note: When upgrading versions, be sure to check the changelog.
+
+## Example
+```gleam
+let filepath = "./test/hello.txt"
+let assert Ok(_) = "Hello, World" |> write(to: filepath)
+let assert Ok(_) = "Goodbye, Mars" |> append(to: filepath)
+let assert Ok("Hello, WorldGoodbye, Mars") = read(from: filepath)
+let assert Ok(_) = delete(filepath)
+let assert Error(_) = read(from: filepath)
+```
+
+## Installation
+
+If available on Hex this package can be added to your Gleam project:
+
+```sh
+gleam add simplifile
+```
+
+and its documentation can be found at <https://hexdocs.pm/simplifile>.