doc: add some docs

Author: Adriano Santos

README.md

@@ -1,2 +1,30 @@
-# spawn-go-sdk
-Go SDK for the Eigr Actor Mesh
+# Spawn Go SDK
+
+# [Spawn](https://github.com/eigr/spawn)
+
+**Spawn Actor Mesh Runtime for Go**
+
+## **Installation**
+
+### Install Spawn CLI
+
+```SH
+curl -sSL https://github.com/eigr/spawn/releases/download/v1.4.3/install.sh | sh
+```
+
+# **Getting Started**
+
+Install go package.
+
+```go
+```
+
+### Create a new project with
+
+```SH
+spawn new go hello_world
+```
+
+## **Examples**
+
+You can check [examples folder](./examples) to see some examples

documentation/actors.md

@@ -0,0 +1,39 @@
+# Actors
+
+his is an example of what kind of Actors you can create with Spawn
+
+## Named Actor
+
+In this example we are creating an actor in a Named way, that is, it is a known actor at compile time. Or a 'global' actor with only one name.
+
+```go
+actorConfig := spawn.ActorConfig{
+    Name:               "UserActor",         // Nome do ator
+    StateType:          &actors.UserState{}, // State type
+    Kind:               spawn.Named,         // Actor Type (Named)
+    Stateful:           true,                // Stateful actor
+    SnapshotTimeout:    60,                  // Snapshot timeout
+    DeactivatedTimeout: 120,                 // Deactivation timeout
+}
+```
+
+```go
+// Creates an actor with the given configuration
+actor := system.BuildActor(actorConfig)
+
+// Define uma ação simples para o ator
+actor.AddAction("ChangeUserName", func(ctx spawn.ActorContext, payload proto.Message) (spawn.Value, error) {
+    // Convert payload to expected type
+    input, ok := payload.(*actors.ChangeUserNamePayload)
+    if !ok {
+        return spawn.Value{}, fmt.Errorf("invalid payload type")
+    }
+
+    // Updates the status and prepares the response
+    state := &actors.UserState{Name: input.NewName}
+    response := &actors.ChangeUserNameResponse{Status: actors.ChangeUserNameResponse_OK}
+
+    // Returns status and response
+    return spawn.Of(state, response), nil
+})
+```

examples/go.mod

@@ -9,4 +9,4 @@ require (
 	google.golang.org/protobuf v1.35.2
 )
 
-replace github.com/eigr/spawn-go-sdk/spawn => ../spawn
+//replace github.com/eigr/spawn-go-sdk/spawn => ../spawn

go.mod

@@ -8,4 +8,4 @@ require (
     github.com/eigr/spawn-go-sdk/spawn v0.1.0
 )
 
-replace github.com/eigr/spawn-go-sdk/spawn => ./spawn
+//replace github.com/eigr/spawn-go-sdk/spawn => ./spawn

go.work.sum

@@ -0,0 +1,6 @@
+github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
+golang.org/x/net v0.28.0/go.mod h1:yqtgsTWOOnlGLG9GFRrK3++bGOUEkNBoHZc8MEDWPNg=
+golang.org/x/sys v0.24.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/text v0.17.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20241206012308-a4fef0638583/go.mod h1:5uTbfoYQed2U9p3KIj2/Zzm02PYhndfdmML0qC3q3FU=
+google.golang.org/grpc v1.67.1/go.mod h1:1gLDyUQU7CTLJI90u3nXZ9ekeghjeM7pTDZlqFNg2AA=