Skip to content

Commit

Permalink
Move README to .md
Browse files Browse the repository at this point in the history
  • Loading branch information
subhashb committed Apr 23, 2024
1 parent ef14b80 commit a65fd70
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 50 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Message-DB-py

Message-DB-py is a Python interface to the MessageDB event store and message store, designed for easy integration into
Python applications.

[![Build Status](https://github.com/subhashb/message-db-py/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/subhashb/message-db-py/actions)
[![Code Coverage](https://codecov.io/gh/subhashb/message-db-py/graph/badge.svg?token=QMNUSLN2OM)](https://codecov.io/gh/subhashb/message-db-py)
[![Python Version](https://img.shields.io/pypi/pyversions/message-db-py.svg)](https://pypi.org/project/message-db-py/)
[![PyPI version](https://badge.fury.io/py/message-db-py.svg)](https://pypi.org/project/message-db-py/)
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Installation

Use pip to install:

```shell
$ pip install message-db-py
```

## Usage

Here's a quick example of how to publish and read messages using Message-DB-py:

```python
from message_db.client import MessageDB

# Initialize the database connection
mdb = MessageDB("your_connection_string")

# Write a message
mdb.write("your_stream_name", "your_message_type", {"data": "value"})

# Read a message
message = mdb.read_last_message("your_stream_name")
print(message)
```
50 changes: 0 additions & 50 deletions README.rst

This file was deleted.

0 comments on commit a65fd70

Please sign in to comment.