aboutsummaryrefslogtreecommitdiff
path: root/aoc2023/build/packages/gleam_erlang/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/gleam_erlang/README.md
parent231c2b688d1e6cf0846d46e883da30e042a9c6cf (diff)
downloadgleam_aoc-612fd986ab1e00b6d34dc1937136250e08e89325.tar.gz
gleam_aoc-612fd986ab1e00b6d34dc1937136250e08e89325.zip
cleanup
Diffstat (limited to 'aoc2023/build/packages/gleam_erlang/README.md')
-rw-r--r--aoc2023/build/packages/gleam_erlang/README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/aoc2023/build/packages/gleam_erlang/README.md b/aoc2023/build/packages/gleam_erlang/README.md
new file mode 100644
index 0000000..ffee4cd
--- /dev/null
+++ b/aoc2023/build/packages/gleam_erlang/README.md
@@ -0,0 +1,37 @@
+# Gleam Erlang 🐙
+
+A library for making use of Erlang specific code!
+
+## Features
+
+- Typed Erlang processes and message sending.
+- Erlang binary format (de)serialisation.
+- Functions for working with Erlang's charlists.
+- Reading, writing, and deletion of files.
+- Basic distributed Erlang support and working with nodes.
+- Reading and writing of environment variables.
+- Functions for working with atoms.
+
+## Usage
+
+Add this library to your Gleam project
+
+```shell
+gleam add gleam_erlang
+```
+
+And then use it in your code
+
+```gleam
+import gleam/io
+import gleam/erlang/file
+
+pub fn main() {
+ assert Ok(contents) = file.read("pokedex.txt")
+ io.println(contents)
+}
+```
+
+Documentation can be found at <https://hexdocs.pm/gleam_erlang/>.
+
+This library requires OTP 23.0 or higher.