docs: add readmes to each crate to direct users to main crate

Closes kemitix/git-next#106

crates/actor-macros/README.md

@@ -0,0 +1,9 @@
+# git-next
+
+## Trunk-based developement manager.
+
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
+
+See [git-next](https://crates.io/crates/git-next) for more information.

crates/config/README.md

@@ -0,0 +1,9 @@
+# git-next
+
+## Trunk-based developement manager.
+
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
+
+See [git-next](https://crates.io/crates/git-next) for more information.

crates/file-watcher-actor/README.md

@@ -0,0 +1,9 @@
+# git-next
+
+## Trunk-based developement manager.
+
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
+
+See [git-next](https://crates.io/crates/git-next) for more information.

crates/forge-forgejo/README.md

@@ -0,0 +1,9 @@
+# git-next
+
+## Trunk-based developement manager.
+
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
+
+See [git-next](https://crates.io/crates/git-next) for more information.

crates/forge-github/README.md

@@ -0,0 +1,9 @@
+# git-next
+
+## Trunk-based developement manager.
+
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
+
+See [git-next](https://crates.io/crates/git-next) for more information.

crates/forge/README.md

@@ -0,0 +1,9 @@
+# git-next
+
+## Trunk-based developement manager.
+
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
+
+See [git-next](https://crates.io/crates/git-next) for more information.

crates/git/README.md

@@ -0,0 +1,9 @@
+# git-next
+
+## Trunk-based developement manager.
+
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
+
+See [git-next](https://crates.io/crates/git-next) for more information.

crates/repo-actor/MESSAGES.md

@@ -0,0 +1,36 @@
+```mermaid
+stateDiagram-v2
+[*] --> CloneRepo :on start
+
+CloneRepo --> LoadConfigFromRepo :on repo config
+CloneRepo --> RegisterWebhook :on server config
+
+LoadConfigFromRepo --> ReceiveRepoConfig
+
+ValidateRepo --> CheckCIStatus :on next ahead of main
+ValidateRepo --> AdvanceNext :on dev ahead of next
+ValidateRepo --> [*] :on dev == next == main
+ValidateRepo --> [*] :on non-retryable error
+ValidateRepo --> ValidateRepo :on retryable error
+
+CheckCIStatus --> ReceiveCIStatus
+
+ReceiveCIStatus --> AdvanceMain :on Pass
+ReceiveCIStatus --> ValidateRepo :on Pending
+ReceiveCIStatus --> [*] :on Fail
+
+AdvanceNext --> ValidateRepo
+
+ReceiveRepoConfig --> RegisterWebhook
+
+RegisterWebhook --> WebhookRegistered
+
+WebhookRegistered --> ValidateRepo
+
+AdvanceMain --> LoadConfigFromRepo :on repo config
+AdvanceMain --> ValidateRepo :on server config
+
+[*] --> WebhookNotification :on push
+
+WebhookNotification --> ValidateRepo
+```

crates/repo-actor/README.md

@@ -1,36 +1,9 @@
-```mermaid
+# git-next
-stateDiagram-v2
-[*] --> CloneRepo :on start
 
-CloneRepo --> LoadConfigFromRepo :on repo config
+## Trunk-based developement manager.
-CloneRepo --> RegisterWebhook :on server config
 
-LoadConfigFromRepo --> ReceiveRepoConfig
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
 
-ValidateRepo --> CheckCIStatus :on next ahead of main
+See [git-next](https://crates.io/crates/git-next) for more information.
-ValidateRepo --> AdvanceNext :on dev ahead of next
-ValidateRepo --> [*] :on dev == next == main
-ValidateRepo --> [*] :on non-retryable error
-ValidateRepo --> ValidateRepo :on retryable error
-
-CheckCIStatus --> ReceiveCIStatus
-
-ReceiveCIStatus --> AdvanceMain :on Pass
-ReceiveCIStatus --> ValidateRepo :on Pending
-ReceiveCIStatus --> [*] :on Fail
-
-AdvanceNext --> ValidateRepo
-
-ReceiveRepoConfig --> RegisterWebhook
-
-RegisterWebhook --> WebhookRegistered
-
-WebhookRegistered --> ValidateRepo
-
-AdvanceMain --> LoadConfigFromRepo :on repo config
-AdvanceMain --> ValidateRepo :on server config
-
-[*] --> WebhookNotification :on push
-
-WebhookNotification --> ValidateRepo
-```

crates/server-actor/MESSAGES.md

@@ -0,0 +1,17 @@
+```mermaid
+stateDiagram-v2
+SERVER --> FileUpdated :on start
+FILE_WATCHER_ACTOR --> FileUpdated : WatchFile
+
+FileUpdated --> ReceiveServerConfig
+
+ReceiveServerConfig --> ReceiveValidServerConfig
+
+ReceiveValidServerConfig --> WEBHOOK_ACTOR:ShutdownWebhook
+ReceiveValidServerConfig --> REPO_ACTOR:START
+ReceiveValidServerConfig --> REPO_ACTOR:CloneRepo
+ReceiveValidServerConfig --> WEBHOOK_ROUTER:START
+ReceiveValidServerConfig --> WEBHOOK_ROUTER:AddWebhookRecipient
+ReceiveValidServerConfig --> WEBHOOK_ACTOR:START
+
+```

crates/server-actor/README.md

@@ -1,17 +1,9 @@
-```mermaid
+# git-next
-stateDiagram-v2
-SERVER --> FileUpdated :on start
-FILE_WATCHER_ACTOR --> FileUpdated : WatchFile
 
-FileUpdated --> ReceiveServerConfig
+## Trunk-based developement manager.
 
-ReceiveServerConfig --> ReceiveValidServerConfig
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
 
-ReceiveValidServerConfig --> WEBHOOK_ACTOR:ShutdownWebhook
+See [git-next](https://crates.io/crates/git-next) for more information.
-ReceiveValidServerConfig --> REPO_ACTOR:START
-ReceiveValidServerConfig --> REPO_ACTOR:CloneRepo
-ReceiveValidServerConfig --> WEBHOOK_ROUTER:START
-ReceiveValidServerConfig --> WEBHOOK_ROUTER:AddWebhookRecipient
-ReceiveValidServerConfig --> WEBHOOK_ACTOR:START
-
-```

crates/server/README.md

@@ -0,0 +1,9 @@
+# git-next
+
+## Trunk-based developement manager.
+
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
+
+See [git-next](https://crates.io/crates/git-next) for more information.

crates/webhook-actor/README.md

@@ -0,0 +1,9 @@
+# git-next
+
+## Trunk-based developement manager.
+
+`git-next` is a combined server and command-line tool that enables trunk-based
+development workflows where each commit must pass CI before being included in
+the main branch.
+
+See [git-next](https://crates.io/crates/git-next) for more information.