Start building out README and basic structure (#590)
This commit is contained in:
parent
ce087a2fd2
commit
0ebf4d33e3
44
README.md
44
README.md
@ -1,12 +1,42 @@
|
||||
# corso
|
||||
CLI/API based backup of M365 data
|
||||
# Corso
|
||||
|
||||
Corso is the first open-source tool that aims to assist admins with the
|
||||
critical task of protecting SaaS service data. It provides a reliable, secure,
|
||||
and efficient data protection engine. Admins decide where backup data is
|
||||
stored and have the flexibility to execute backups of their desired service
|
||||
through an intuitive interface. As Corso evolves, it can become a great
|
||||
building block for more complex data protection workflows.
|
||||
|
||||
Corso is initially focused on protecting data in Microsoft 365 services such
|
||||
as Exchange, OneDrive, SharePoint, and Teams. The goals is to expand coverage
|
||||
for additional services, M365 or others, over time based on the interest and
|
||||
needs of the community.
|
||||
|
||||
# Getting Started
|
||||
|
||||
```sh
|
||||
# Build
|
||||
./build/build.sh # this will create a binary in bin/
|
||||
TODO - Link to the appropriate page in the published docs.
|
||||
|
||||
# Docker Image
|
||||
./build/build-container.sh # this will build an image
|
||||
# Building Corso
|
||||
|
||||
```sh
|
||||
# Build a binary. Will be places in bin/
|
||||
./build/build.sh
|
||||
|
||||
# Build a container image
|
||||
./build/build-container.sh
|
||||
```
|
||||
|
||||
# Contribution Guidelines
|
||||
|
||||
TODO
|
||||
|
||||
# Code of Conduct
|
||||
|
||||
It is important that our community is inclusive and respectful of everyone.
|
||||
We ask that all Corso users and contributors take a few minutes to review our
|
||||
[Code of Conduct](CODE_OF_CONDUCT.md)
|
||||
|
||||
# License
|
||||
|
||||
TODO
|
||||
`
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user