Skip to content

Commit 51a0b8a

Browse files
authored
docs: add installation quickstart (#24)
--------- Signed-off-by: Miguel Martinez Trivino <[email protected]>
1 parent a01aeb1 commit 51a0b8a

File tree

2 files changed

+21
-4
lines changed

2 files changed

+21
-4
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,22 @@ Developer teams, on the other hand, do not need to become security experts, the
1313

1414
To learn more about the project motivation please look at [this blog post](https://docs.chainloop.dev/blog/introducing-chainloop) and see it in action in [this video](https://docs.chainloop.dev/blog/software-supply-chain-attestation-easy-way#see-it-in-action).
1515

16+
## Getting started
17+
18+
See the getting started [guide](https://docs.chainloop.dev/getting-started/installation) for detailed information on downloading and configuring the Chainloop Command Line Interface (CLI)
19+
20+
In a nutshell:
21+
22+
```bash
23+
$ curl -sfL https://docs.chainloop.dev/install.sh | bash -s
24+
25+
$ chainloop auth login
26+
```
27+
28+
> NOTE: You can also build and run Chainloop [from source](./CONTRIBUTING.md)
29+
30+
> Once you've been logged in, follow [these instructions](https://docs.chainloop.dev/getting-started/setup) to learn how to set up your account.
31+
1632
## How does it work?
1733

1834
### Compliant Single Source of Truth
@@ -43,7 +59,7 @@ Operators can set up third-party integrations such as [Dependency-Track](https:/
4359

4460
Ops can mix and match with different integrations while **not requiring developers to make any changes on their side**!
4561

46-
## Role-tailored experience
62+
### Role-tailored experience
4763

4864
Chainloop makes sure to clearly define the responsibilities, experience and functional scope of the **two main personas, Security/Operation (SecOps) and Development/Application teams**.
4965

@@ -60,7 +76,8 @@ To learn more, please visit the Chainloop project's documentation website, https
6076
Chainloop is developed in the open and is constantly improved by our users, contributors and maintainers. Got a question, comment, or idea? Please don't hesitate to reach out via:
6177

6278
- GitHub [Issues](https://github.com/chainloop-dev/chainloop/issues)
63-
- [Discord Community Server](https://discord.gg/f7atkaZact)
79+
- Discord [Community Server](https://discord.gg/f7atkaZact)
80+
- Youtube [Channel](https://www.youtube.com/channel/UCISrWrPyR_AFjIQYmxAyKdg)
6481

6582
## Contributing
6683

internal/blobmanager/oci/backend.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ func NewBackend(repository string, regOpts *RegistryOptions) (*Backend, error) {
6161
}
6262

6363
// Exists check that the artifact is already present in the repository and it points to the
64-
// same image digest, meaning it has not been repushed/replaced
64+
// same image digest, meaning it has not been re-pushed/replaced
6565
// This method is very naive so signatures will be used in future releases
6666
func (b *Backend) Exists(ctx context.Context, digest string) (bool, error) {
6767
if digest == "" {
@@ -74,7 +74,7 @@ func (b *Backend) Exists(ctx context.Context, digest string) (bool, error) {
7474
}
7575

7676
// It's not trivial to catch if the error is a 404 (yeah I know...) so we will assume that
77-
// any error means no and will be catched in the next stage when we try to upload the image
77+
// any error means no and will be caught in the next stage when we try to upload the image
7878
image, err := remote.Image(ref, remote.WithAuthFromKeychain(b.keychain))
7979
if err != nil {
8080
// Image is not there

0 commit comments

Comments
 (0)