Skip to content

Commit

Permalink
docs(readme): minor revisions (#470)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewazores authored May 21, 2024
1 parent a92bf02 commit b6da1bb
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Cryostat3
# Cryostat

[![CI build and push](https://github.com/cryostatio/cryostat3/actions/workflows/push-ci.yaml/badge.svg)](https://github.com/cryostatio/cryostat3/actions/workflows/push-ci.yaml)
[![Google Group : Cryostat Development](https://img.shields.io/badge/Google%20Group-Cryostat%20Development-blue.svg)](https://groups.google.com/g/cryostat-development)

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
## USING

## PREVIEW
Most users will be best served starting at [`cryostat.io`](https://cryostat.io), the documentation website for Cryostat.
Here you will find instructions on how to install Cryostat using the [Cryostat Operator](https://github.com/cryostatio/cryostat-operator),
how to configure your applications to enable connectivity, and how to use the Cryostat application.

This repository is in an active development, early preview state, and will eventually be used for `3.x` release
versions of Cryostat. See [cryostatio/cryostat](https://github.com/cryostatio/cryostat) for the old repository
containing the `< 3.0` codebase.
This repository contains the source code for Cryostat versions 3.0 and later. Cryostat (née "container-jfr") versions prior to 3.0
are located at [cryostatio/cryostat](https://github.com/cryostatio/cryostat). Container images from both are published to the same
[`quay.io`](https://quay.io/repository/cryostat/cryostat) repository.

## CONTRIBUTING

We welcome and appreciate any contributions from our community. Please visit our guide on how you can take part in improving Cryostat3.
We welcome and appreciate any contributions from our community. Please visit our guide on how you can take part in improving Cryostat.

[See contribution guide →](./CONTRIBUTING.md)

Expand All @@ -36,6 +36,10 @@ Run Requirements:

## BUILD

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

### Setup Dependencies

For ease and convenience, it is suggested to use `podman` with the following configurations:
Expand Down

0 comments on commit b6da1bb

Please sign in to comment.