Improve documentation

Author: lpil

README.md

@@ -5,6 +5,48 @@ Fault tolerant multi-core programs with OTP, the BEAM actor framework.
 [![Package Version](https://img.shields.io/hexpm/v/gleam_otp)](https://hex.pm/packages/gleam_otp)
 [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/gleam_otp/)
 
+```shell
+gleam add gleam_otp
+```
+```gleam
+import gleam/erlang/process.{type Subject}
+import gleam/otp/actor
+
+pub fn main() {
+  // Start an actor
+  let assert Ok(actor) =
+    actor.new(0)
+    |> actor.on_message(handle_message)
+    |> actor.start
+
+  // Send some messages to the actor
+  actor.send(actor.data, Add(5))
+  actor.send(actor.data, Add(3))
+
+  // Send a message and get a reply
+  assert actor.call(actor.data, 10, Get) == 8
+}
+
+pub fn handle_message(state: Int, message: Message) -> actor.Next(Int, Message) {
+  case message {
+    Add(i) -> {
+      let state = state + i
+      actor.continue(state)
+    }
+    Get(reply) -> {
+      actor.send(reply, state)
+      actor.continue(state)
+    }
+  }
+}
+
+pub type Message {
+  Add(Int)
+  Get(Subject(Int))
+}
+```gleam
+
+
 Gleam’s actor system is built with a few primary goals:
 
 - Full type safety of actors and messages.
@@ -21,14 +63,6 @@ Not all Erlang/OTP functionality is included in this library. Some is not
 possible to represent in a type safe way, so it is not included. Other features
 are still in development, such as further process supervision strategies.
 
-## Usage
-
-Add this library to your Gleam project.
-
-```shell
-gleam add gleam_otp
-```
-
 ## Common types of actor
 
 This library provides several different types of actor that can be used in

gleam.toml

@@ -3,7 +3,7 @@ version = "1.0.0"
 licences = ["Apache-2.0"]
 description = "Fault tolerant multi-core programs with OTP, the BEAM actor framework."
 
-gleam = ">= 1.7.0"
+gleam = ">= 1.11.0"
 
 repository = { type = "github", user = "gleam-lang", repo = "otp" }
 links = [
@@ -13,7 +13,7 @@ links = [
 
 [dependencies]
 gleam_stdlib = ">= 0.60.0 and < 2.0.0"
-gleam_erlang = ">= 1.0.0-rc1 and < 2.0.0"
+gleam_erlang = ">= 1.0.0 and < 2.0.0"
 
 [dev-dependencies]
 gleeunit = ">= 1.0.0 and < 2.0.0"

manifest.toml

@@ -2,14 +2,14 @@
 # You typically do not need to edit this file
 
 packages = [
-  { name = "gleam_erlang", version = "1.0.0-rc1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "6E0CF4E1F66E2C9226B7554589544F00F12CE14858440EB1BF7EFDACDE1BBC64" },
+  { name = "gleam_erlang", version = "1.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "7E6A5234F927C4B24F8054AB1E4572206C41F9E6D5C6C02273CB7531E7E5CED0" },
   { name = "gleam_stdlib", version = "0.60.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "621D600BB134BC239CB2537630899817B1A42E60A1D46C5E9F3FAE39F88C800B" },
-  { name = "gleeunit", version = "1.4.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "12A8A2B510D7063547CD73AE5345544AE92124247A82F46B05F5B0913EE28BC8" },
+  { name = "gleeunit", version = "1.5.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "D33B7736CF0766ED3065F64A1EBB351E72B2E8DE39BAFC8ADA0E35E92A6A934F" },
   { name = "logging", version = "1.3.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "logging", source = "hex", outer_checksum = "1098FBF10B54B44C2C7FDF0B01C1253CAFACDACABEFB4B0D027803246753E06D" },
 ]
 
 [requirements]
-gleam_erlang = { version = ">= 1.0.0-rc1 and < 2.0.0" }
+gleam_erlang = { version = ">= 1.0.0 and < 2.0.0" }
 gleam_stdlib = { version = ">= 0.60.0 and < 2.0.0" }
 gleeunit = { version = ">= 1.0.0 and < 2.0.0" }
 logging = { version = ">= 1.3.0 and < 2.0.0" }

test/gleam/otp/readme_example_test.gleam

@@ -0,0 +1,41 @@
+pub fn main_test() {
+  main()
+}
+
+// ----- Example begins here --------------------------------------------------
+
+import gleam/erlang/process.{type Subject}
+import gleam/otp/actor
+
+pub fn main() {
+  // Start an actor
+  let assert Ok(actor) =
+    actor.new(0)
+    |> actor.on_message(handle_message)
+    |> actor.start
+
+  // Send some messages to the actor
+  actor.send(actor.data, Add(5))
+  actor.send(actor.data, Add(3))
+
+  // Send a message and get a reply
+  assert actor.call(actor.data, 10, Get) == 8
+}
+
+pub fn handle_message(state: Int, message: Message) -> actor.Next(Int, Message) {
+  case message {
+    Add(i) -> {
+      let state = state + i
+      actor.continue(state)
+    }
+    Get(reply) -> {
+      actor.send(reply, state)
+      actor.continue(state)
+    }
+  }
+}
+
+pub type Message {
+  Add(Int)
+  Get(Subject(Int))
+}