Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guibranco authored Nov 15, 2024
1 parent e44f117 commit 83c67df
Showing 1 changed file with 62 additions and 4 deletions.
66 changes: 62 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Hello World Rebus

📚 A repository to learn [Rebus]()
📚 A repository to explore and learn **[Rebus](https://github.com/rebus-org/Rebus)** with .NET.

Check notice on line 3 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L3

Expected: 80; Actual: 95

[![wakatime](https://wakatime.com/badge/github/GuilhermeStracini/hello-world-rebus.svg)](https://wakatime.com/badge/github/GuilhermeStracini/hello-world-rebus)
[![Maintainability](https://api.codeclimate.com/v1/badges/b3f0aedd63fff2c00f19/maintainability)](https://codeclimate.com/github/GuilhermeStracini/hello-world-rebus/maintainability)
Expand All @@ -10,8 +10,66 @@
[![GitHub last commit](https://img.shields.io/github/last-commit/GuilhermeStracini/hello-world-rebus)](https://github.com/GuilhermeStracini/hello-world-rebus)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/b491fdc0fa5a4f46badb451bfb07569e)](https://app.codacy.com/gh/GuilhermeStracini/hello-world-rebus/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)

## Useful links
---

- [Rebus](https://github.com/rebus-org/Rebus)
- [RebusSamples](https://github.com/rebus-org/RebusSamples)
## About

This repository demonstrates the basics of **Rebus**, a simple and flexible service bus library for .NET. It is designed to help developers implement reliable messaging patterns like publish/subscribe and sagas.

Check notice on line 17 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L17

Expected: 80; Actual: 211

---

## Features

- **Reliable Messaging**: Easily send and receive messages across services.
- **Integration with RabbitMQ**: Demonstrates usage with RabbitMQ as a transport layer.

Check notice on line 24 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L24

Expected: 80; Actual: 87
- **Saga Pattern**: Learn to implement the saga pattern for managing long-running workflows.

Check notice on line 25 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L25

Expected: 80; Actual: 92

---

## Prerequisites

To get started with this repository, you need:
- **.NET SDK**: Available [here](https://dotnet.microsoft.com/download).

Check notice on line 32 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L32

Lists should be surrounded by blank lines
- **RabbitMQ**: Installed and running locally or accessible in your environment.

---

## Setup

1. Clone the repository:
```bash

Check notice on line 40 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L40

Fenced code blocks should be surrounded by blank lines
git clone https://github.com/GuilhermeStracini/hello-world-rebus.git
```

Check notice on line 42 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L42

Fenced code blocks should be surrounded by blank lines
2. Navigate to the project directory:
```bash
cd hello-world-rebus
```
3. Restore dependencies:
```bash
dotnet restore
```
4. Update configuration for RabbitMQ (if needed) in the app settings.
5. Run the application:
```bash
dotnet run
```

---

## Useful Links

- [Rebus Official Documentation](https://github.com/rebus-org/Rebus)
- [Rebus Samples](https://github.com/rebus-org/RebusSamples)
- [Saga with Rebus + RabbitMQ](https://medium.com/@MilanJovanovicTech/mnw-031-implementing-the-saga-pattern-with-rebus-and-rabbitmq-5a42d28dc7e4)

---

## License

This project is licensed under the [MIT License](LICENSE).

---

## Contribution

Contributions are welcome! Feel free to fork this repository, create a branch, and submit a pull request.

Check notice on line 75 in README.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

README.md#L75

Expected: 80; Actual: 105

0 comments on commit 83c67df

Please sign in to comment.