corso/src/README.md
Keepers f368c596b5
add readme to corso/src (#101) (#102)
Additional documentation to help guide new developers through the
repository layout and design decisions backing that layout.
2022-06-01 12:05:26 -06:00

20 lines
561 B
Markdown

# 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.