Skip to content

Commit

Permalink
chore: update readme with badges (#225)
Browse files Browse the repository at this point in the history
Co-authored-by: UncleGedd <42304551+UncleGedd@users.noreply.github.com>
  • Loading branch information
TristanHoladay and UncleGedd authored Sep 19, 2024
1 parent 59ee0da commit 38df19a
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pr-tests.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: PR Tests
name: Tests
on:
workflow_call:
pull_request:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/scan-lint.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Validate Lint
name: Lint
on:
pull_request:
branches: [main]
Expand Down
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# UDS Runtime

<img align="right" alt="zarf logo" src="ui/static/doug.svg" height="256" />

[![Latest Release](https://img.shields.io/github/v/release/defenseunicorns/uds-runtime)](https://github.com/defenseunicorns/uds-runtime/releases)
[![Go version](https://img.shields.io/github/go-mod/go-version/defenseunicorns/uds-runtime?filename=go.mod)](https://go.dev/)
[![Build Status](https://img.shields.io/github/actions/workflow/status/defenseunicorns/uds-runtime/tag-and-release.yaml)](https://github.com/defenseunicorns/uds-runtime/actions/workflows/tag-and-release.yaml)

[![Go Report Card](https://goreportcard.com/badge/github.com/defenseunicorns/uds-runtime)](https://goreportcard.com/report/github.com/defenseunicorns/uds-runtime)
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/defenseunicorns/uds-runtime/badge)](https://scorecard.dev/viewer/?uri=github.com/defenseunicorns/uds-runtime)

[![UDS Documentation](https://img.shields.io/badge/docs-uds.defenseunicorns.com-775ba1)](https://uds.defenseunicorns.com/docs/)

UDS Runtime is the frontend for all things UDS, providing views and insights into your UDS cluster.

## Quickstart Deploy
Expand All @@ -10,11 +21,13 @@ UDS Runtime is the frontend for all things UDS, providing views and insights int
### Pre-requisites

Recommended:
* [UDS-CLI](https://github.com/defenseunicorns/UDS-CLI#install)

- [UDS-CLI](https://github.com/defenseunicorns/UDS-CLI#install)

If building locally:
* `Go >= 1.22.0`
* `Node >= v21.1.0`

- `Go >= 1.22.0`
- `Node >= v21.1.0`

### In Cluster

Expand All @@ -24,7 +37,7 @@ Assumes a K8s cluster is running and the appropriate K8s context has been select
uds zarf package deploy oci://ghcr.io/defenseunicorns/packages/uds/uds-runtime:<tag> --confirm
```

**See [all tags](https://github.com/defenseunicorns/uds-runtime/pkgs/container/packages%2Fuds%2Fuds-runtime)*
\*_See [all tags](https://github.com/defenseunicorns/uds-runtime/pkgs/container/packages%2Fuds%2Fuds-runtime)_

### Locally (Out of Cluster)

Expand All @@ -39,11 +52,13 @@ For a full guide on developing for UDS Runtime, please read the [CONTRIBUTING.md
### To start the backend development server, run the following command:

**With UDS-CLI**

```bash
uds run dev-server
```

**Without UDS-CLI**

```bash
air
```
Expand All @@ -53,11 +68,13 @@ air
### To start the frontend server, run the following command:

**With UDS-CLI**

```bash
uds run dev-ui
```

**Wihtout UDS-CLI**

```bash
cd ui
npm ci
Expand Down

0 comments on commit 38df19a

Please sign in to comment.