initial commit

1 files changed, 7 insertions, 0 deletions

diff --git a/phony/doc.go b/phony/doc.go
new file mode 100644
index 0000000..554cc80
--- /dev/null
+++ b/phony/doc.go
@@ -0,0 +1,7 @@
+// Package phony is a small actor model library for Go, inspired by the causal messaging system in the Pony programming language.
+// An Actor is an interface satisfied by a lightweight Inbox struct.
+// Structs that embed an Inbox satisfy an interface that allows them to send messages to eachother.
+// Messages are functions of 0 arguments, typically closures, and should not perform blocking operations.
+// Message passing is asynchronous, causal, and fast.
+// Actors implemented by the provided Inbox struct are scheduled to prevent messages queues from growing too large, by pausing at safe breakpoints when an Actor detects that it sent something to another Actor whose inbox is flooded.
+package phony