From 0a1932b24ea1c7363e5b3ffa88109d1c3dc2250a Mon Sep 17 00:00:00 2001
From: Benjamin Wenger <ben@elixxir.ioo>
Date: Thu, 1 Sep 2022 15:13:59 -0700
Subject: [PATCH] made a readme

---
 channels/manager.go | 19 -------------------
 channels/readme.md  | 21 +++++++++++++++++++++
 2 files changed, 21 insertions(+), 19 deletions(-)
 create mode 100644 channels/readme.md

diff --git a/channels/manager.go b/channels/manager.go
index 539d1a4e2..cfb01721b 100644
--- a/channels/manager.go
+++ b/channels/manager.go
@@ -10,25 +10,6 @@
 // replies, reactions, and eventually admin commands.
 package channels
 
-// on sending, data propagates as follows:
-// Send function (Example: SendMessage) - > SendGeneric ->
-//     Broadcast.BroadcastWithAssembler -> cmix.SendWithAssembler
-
-// on receiving messages propagate as follows:
-// cmix message pickup (by service)- > broadcast.Processor ->
-//     userListener ->  events.triggerEvent ->
-//     messageTypeHandler (example: Text) ->
-//     eventModel (example: ReceiveMessage)
-
-// on sendingAdmin, data propagates as follows:
-// Send function - > SendAdminGeneric ->
-//     Broadcast.BroadcastAsymmetricWithAssembler -> cmix.SendWithAssembler
-
-// on receiving admin messages propagate as follows:
-// cmix message pickup (by service)- > broadcast.Processor -> adminListener ->
-//     events.triggerAdminEvent -> messageTypeHandler (example: Text) ->
-//     eventModel (example: ReceiveMessage)
-
 import (
 	"gitlab.com/elixxir/client/broadcast"
 	"gitlab.com/elixxir/client/storage/versioned"
diff --git a/channels/readme.md b/channels/readme.md
new file mode 100644
index 000000000..9327e9635
--- /dev/null
+++ b/channels/readme.md
@@ -0,0 +1,21 @@
+Channels provides a channels implementation on top of broadcast which is capable of handing the user facing features of
+channels, including replies, reactions, and eventually admin commands.
+
+on sending, data propagates as follows:
+Send function (Example: SendMessage) - > SendGeneric ->
+Broadcast.BroadcastWithAssembler -> cmix.SendWithAssembler
+
+on receiving messages propagate as follows:
+cmix message pickup (by service)- > broadcast.Processor ->
+userListener ->  events.triggerEvent ->
+messageTypeHandler (example: Text) ->
+eventModel (example: ReceiveMessage)
+
+on sendingAdmin, data propagates as follows:
+Send function - > SendAdminGeneric ->
+Broadcast.BroadcastAsymmetricWithAssembler -> cmix.SendWithAssembler
+
+on receiving admin messages propagate as follows:
+cmix message pickup (by service)- > broadcast.Processor -> adminListener ->
+events.triggerAdminEvent -> messageTypeHandler (example: Text) ->
+eventModel (example: ReceiveMessage)
\ No newline at end of file
-- 
GitLab