Skip to content

Commit

Permalink
Merge pull request #30 from ezgidemirel/readme
Browse files Browse the repository at this point in the history
Add contribution guides and badges
  • Loading branch information
ezgidemirel authored Oct 17, 2022
2 parents 661f402 + ededf19 commit 8a467bf
Showing 1 changed file with 12 additions and 33 deletions.
45 changes: 12 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# Provider GCP
# Official Provider GCP

<div align="center">

![CI](https://github.com/upbound/provider-gcp/workflows/CI/badge.svg) [![GitHub release](https://img.shields.io/github/release/upbound/provider-gcp/all.svg?style=flat-square)](https://github.com/upbound/provider-gcp/releases) [![Go Report Card](https://goreportcard.com/badge/github.com/upbound/provider-gcp)](https://goreportcard.com/report/github.com/upbound/provider-gcp) [![Slack](https://slack.crossplane.io/badge.svg)](https://crossplane.slack.com/archives/C01TRKD4623) [![Twitter Follow](https://img.shields.io/twitter/follow/upbound_io.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=upbound_io&user_id=788180534543339520)

</div>

`provider-gcp` is a [Crossplane](https://crossplane.io/) provider that
is built using [Upjet](https://github.com/upbound/upjet) code
Expand All @@ -10,42 +16,15 @@ GCP API.
Follow the quick start guide [here](https://marketplace.upbound.io/providers/upbound/provider-gcp/latest/docs/quickstart).
You can find a detailed API reference with all CRDs and examples [here](https://marketplace.upbound.io/providers/upbound/provider-gcp)

## Developing

Run code-generation pipeline:
```console
go run cmd/generator/main.go
```

Run against a Kubernetes cluster:

```console
make run
```

Build, push, and install:

```console
make all
```

Build image:

```console
make image
```
## Contributing

Push image:
For the general contribution guide, see [Upjet Contribution Guide](https://github.com/upbound/upjet/blob/main/CONTRIBUTING.md)

```console
make push
```
If you'd like to learn how to use Upjet, see [Usage Guide](https://github.com/upbound/upjet/tree/main/docs).

Build binary:
### Add a New Resource

```console
make build
```
Follow the guide [here](https://github.com/upbound/upjet/blob/main/docs/add-new-resource-short.md).

## Report a Bug

Expand Down

0 comments on commit 8a467bf

Please sign in to comment.