larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add readme to corso/src (#101) (#102)

Browse Source 
Additional documentation to help guide new developers through the
repository layout and design decisions backing that layout.
This commit is contained in:
Keepers 2022-06-01 12:05:26 -06:00 committed by GitHub
parent 596a4cc37b
commit f368c596b5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/README.md Normal file
View File

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