From 96a3c5c179d8d3fff24eb2953e45f8dd15e2714c Mon Sep 17 00:00:00 2001
From: HJ <thechairman@thechairman.info>
Date: Sat, 3 Feb 2024 15:09:54 -0500
Subject: cleanup

---
 aoc2023/build/packages/simplifile/README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 aoc2023/build/packages/simplifile/README.md

(limited to 'aoc2023/build/packages/simplifile/README.md')

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>.
-- 
cgit v1.2.3