From f368c596b5d132d7d1274a40206cde003e0f1b84 Mon Sep 17 00:00:00 2001
From: Keepers <104464746+ryanfkeepers@users.noreply.github.com>
Date: Wed, 1 Jun 2022 12:05:26 -0600
Subject: [PATCH] add readme to corso/src (#101) (#102)

Additional documentation to help guide new developers through the
repository layout and design decisions backing that layout.
---
 src/README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 src/README.md

diff --git a/src/README.md b/src/README.md
new file mode 100644
index 000000000..03769a1ce
--- /dev/null
+++ b/src/README.md
@@ -0,0 +1,20 @@
+# SRC Directory
+
+## /pkg
+API and Components which are exposed for external usage.
+
+* /pkg/repository  
+Control layer for coordinating connections and communication with storage provider repositories.
+
+* /pkg/storage  
+Manages compilation and validation of repository configuration and consts.  Both those that are specific to storage providers, and those that are provider-agnostic.
+
+-----
+
+## /cli
+Command Line Interface controller.  Utilizes /pkg/repository as an exernal dependency.
+
+-----
+
+## /internal
+Packages which are only intended for use within Corso.
\ No newline at end of file