Skip to content

Commit

Permalink
[DPE-3023] Add badges to README.md (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
deusebio authored Dec 4, 2023
1 parent 362c93d commit ae433aa
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
# charmed-kafka-snap
# Charmed Kafka snap repository.

Charmed Kafka snap repository.

This snap is based on the kafka snap: https://git.launchpad.net/kafka-snap/
[![Snapcraft Badge](https://snapcraft.io/charmed-kafka/badge.svg)](https://snapcraft.io/charmed-kafka)
[![Release](https://github.com/canonical/charmed-kafka-snap/actions/workflows/publish.yaml/badge.svg)](https://github.com/canonical/charmed-kafka-snap/actions/workflows/publish.yaml)

## Building

To build locally, use `snapcraft --debug`

## Using the snap

Install the snap (e.g. `sudo snap install ./kafka_3.3.2_amd64.snap --dangerous`
Install the snap (e.g. `sudo snap install ./charmed-kafka_3.6.0_amd64.snap --dangerous`
--devmode).

To run the snap, you will require a running Apache ZooKeeper service. You can use the following:
Expand Down

0 comments on commit ae433aa

Please sign in to comment.