Skip to content

Commit 5147a2f

Browse files
committed
docs: adjusting readme and contributing documents
1 parent b3ddd58 commit 5147a2f

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
### **Contributing to Beerus**
1+
### 🤝 **Contributing to Beerus**
22

33
Thank you for your interest in contributing to **Beerus**! 🎉 We appreciate your help in making this project better. Please follow the guidelines below to ensure a smooth contribution process.
44

55
---
66

7-
## Development Setup
7+
## 💻 Development Setup
88

9-
### Prerequisites
9+
### Prerequisites
1010

1111
- Go 1.23+
1212
- Docker
1313
- pre-commit
1414
- golangci-lint
1515

16-
### Local Setup
16+
### ⚙️ Local Setup
1717

1818
1. **Fork the Repository**
1919
- Click the "Fork" button at the top right of this repository.
@@ -68,7 +68,7 @@ Thank you for your interest in contributing to **Beerus**! 🎉 We appreciate yo
6868
6969
---
7070
71-
## **Code Guidelines**
71+
## 📜 **Code Guidelines**
7272
7373
- Follow the existing **coding style** and project conventions.
7474
- Write **unit tests** for new features and bug fixes.
@@ -77,7 +77,7 @@ Thank you for your interest in contributing to **Beerus**! 🎉 We appreciate yo
7777
7878
---
7979
80-
## **Reporting Issues**
80+
## 🐛 **Reporting Issues**
8181
8282
If you find a bug or have a feature request, please **open an issue**:
8383
@@ -87,7 +87,7 @@ If you find a bug or have a feature request, please **open an issue**:
8787
8888
---
8989
90-
## **Code of Conduct**
90+
## 👮‍♀️ **Code of Conduct**
9191
9292
We follow the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/). Please be respectful and inclusive to maintain a welcoming community.
9393

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,20 +77,24 @@ Before getting started with __beerus__, ensure your runtime environment meets th
7777
```sh
7878
# running using environment variables
7979
❯ docker run \
80-
-e BEERUS_IMAGES_LIFETIME_THRESHOLD=1 \
80+
-e BEERUS_IMAGES_LIFETIME_THRESHOLD=5 \
81+
-e BEERUS_EXPIRING_POLL_CHECK_INTERVAL=24 \
82+
-e BEERUS_LOG_LEVEL=debug \
8183
-v /var/run/docker.sock:/var/run/docker.sock:ro \
82-
lucasmendesl/beerus:0.1.0 hakai
84+
lucasmendesl/beerus:latest hakai
8385

8486
#running using cli flags
8587
❯ docker run \
8688
-v /var/run/docker.sock:/var/run/docker.sock:ro \
87-
ghcr.io/lucasmendesl/beerus:0.1.0 hakai --lifetime-threshold=100
89+
ghcr.io/lucasmendesl/beerus:latest hakai --lifetime-threshold=100
8890
```
8991

90-
#### 📦 Avaliable Registries
92+
#### 📦 Available Registries
9193

92-
1. **ghcr.io/lucasmendesl/beerus (ghcr.io)**
93-
2. **lucasmendesl/beerus:0.1.0 (dockerhub)**
94+
| Registry | Command |
95+
|----------|---------|
96+
| ghcr.io | docker pull ghcr.io/lucasmendesl/beerus |
97+
| DockerHub| docker pull lucasmendesl/beerus |
9498

9599

96100
#### 🛠 Configuration

0 commit comments

Comments
 (0)