aboutsummaryrefslogtreecommitdiff
path: root/aoc2023/build/packages/gleam_erlang/README.md
diff options
context:
space:
mode:
authorHJ <thechairman@thechairman.info>2024-02-03 15:09:54 -0500
committerHJ <thechairman@thechairman.info>2024-02-03 15:09:54 -0500
commit96a3c5c179d8d3fff24eb2953e45f8dd15e2714c (patch)
tree0a67bc0cfeabe51740bb049c61f16f1ac3bdd4ff /aoc2023/build/packages/gleam_erlang/README.md
parent547fe03cf43105f46160e2dd9afff21637eaaf47 (diff)
downloadgleam_aoc-96a3c5c179d8d3fff24eb2953e45f8dd15e2714c.tar.gz
gleam_aoc-96a3c5c179d8d3fff24eb2953e45f8dd15e2714c.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.