Skip to content

Commit fd2337b

Browse files
authored
Update README.md
1 parent d2fa2ec commit fd2337b

File tree

1 file changed

+31
-31
lines changed

1 file changed

+31
-31
lines changed

README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,18 @@
11
# Cavorite
22

3-
<img src="images/cavorite_logo.png" alt="drawing" width="80" background-color="transparent" align="left"/> A cli tool that makes it easy to track large, binary files in source control repositories by making them "lighter weight" and making binaries less of a burden. Cavorite is compatible with _any_ SCM system.
3+
<img src="images/cavorite_logo.png" alt="drawing" width="80" background-color="transparent" align="left"/> A cli tool that makes it easy to track large, binary files in source control repositories by swapping the binary files with json metadata. Cavorite is compatible with _any_ SCM system because the binaries are tracked by json metadata files.
44

55
<br/>
66

77
## **Disclaimer**
88

9-
This is not production ready nor feature complete. See [Issues](https://github.com/discentem/cavorite/issues) for upcoming features.
9+
This is not production ready nor feature complete. See [Issues](https://github.com/discentem/cavorite/issues) for future features.
1010

11-
Inspired by https://github.com/facebook/IT-CPE/tree/main/pantri, this is a re-write in Go with support for s3, Minio, Google Cloud Storage, and other storage systems through plugins. See [stores](stores) for information about implementing new storage drivers.
11+
Inspired by https://github.com/facebook/IT-CPE/tree/main/pantri, Cavorite is a re-write in Go with support for s3, Minio, Google Cloud Storage, and other storage systems through plugins. See [stores](stores) for information about implementing new storage drivers.
1212

13-
## Development
14-
15-
### Prerequisites
16-
17-
Install [bazelisk](https://github.com/bazelbuild/bazelisk)
18-
19-
### How to build
20-
21-
#### with Bazel
22-
23-
`make`
24-
25-
#### with go build
26-
27-
`make go_build`
28-
29-
### Linting
30-
31-
`make lint`
32-
33-
### Unit Tests
34-
35-
`make test`
36-
37-
## End-to-end testing workflow
13+
## Using Cavorite
3814

39-
### Minio (S3)
15+
### Minio (S3) backend
4016

4117
> These steps for Minio are also performed automatically by our integration test on each pull request and push: [.github/workflows/integration-test.yaml](.github/workflows/integration-test.yaml)
4218
@@ -73,7 +49,7 @@ Install [bazelisk](https://github.com/bazelbuild/bazelisk)
7349
$ export AWS_SECRET_ACCESS_KEY=minioadmin
7450
```
7551

76-
1. Initialize cavorite. This assumes default Minio credentials. **You should change these credentials for a production deployment**.
52+
1. Initialize cavorite.
7753

7854
```shell
7955
$ $cavorite_BIN init ~/some_git_project --backend_address http://127.0.0.1:9000/test --store_type=s3 --region="us-east-1"
@@ -136,7 +112,7 @@ Install [bazelisk](https://github.com/bazelbuild/bazelisk)
136112
2022/10/18 21:57:53 Retrieving [~/some_git_project/googlechromebeta.dmg]
137113
```
138114

139-
### Testing a plugin-based backend (experimental)
115+
### Plugin backend (arbitrary storage backends at runtime!)
140116

141117
> This is not yet tested automatically in Github Actions.
142118
@@ -220,3 +196,27 @@ Install [bazelisk](https://github.com/bazelbuild/bazelisk)
220196
```
221197

222198
1. `$CAVORITE_BIN retrieve blob.txt.cfile`
199+
200+
## Development
201+
202+
### Prerequisites
203+
204+
Install [bazelisk](https://github.com/bazelbuild/bazelisk)
205+
206+
### How to build
207+
208+
#### with Bazel
209+
210+
`make`
211+
212+
#### with go build
213+
214+
`make go_build`
215+
216+
### Linting
217+
218+
`make lint`
219+
220+
### Unit Tests
221+
222+
`make test`

0 commit comments

Comments
 (0)