Skip to content

Commit 9ba6e39

Browse files
committed
Readme is more complete
1 parent 14c0eb9 commit 9ba6e39

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,30 @@
66

77
A fully-featured event store and message store implemented entirely in PostgreSQL, supporting event sourcing and messaging applications and services.
88

9+
## Features
10+
11+
- Pub/Sub
12+
- JSON message data
13+
- Event streams
14+
- Metadata
15+
- Message storage
16+
- Consumer groups
17+
- Service host
18+
- Administration tools
19+
- Reports
20+
21+
## Rationale
22+
23+
An event sourcing and Pub/Sub message store built on Postgres for simple cloud or local hosting. An implementation of the essential features of tools like [Event Store](https://eventstore.org), with built-in support for messaging patterns like Pub/Sub, and consumer patterns like consumer groups.
24+
25+
Message DB was extracted from the [Eventide Project](http://docs.eventide-project.org) to make it easier for users to write clients in the language of their choosing.
26+
27+
## User Guide
28+
29+
A complete user guide is available on the Eventide Project docs site:
30+
31+
[http://docs.eventide-project.org/user-guide/message-db/](http://docs.eventide-project.org/user-guide/message-db/)
32+
933
## Ruby Distribution of Message DB
1034

1135
This library is a Ruby Gem package of the Message DB database for Postgres.
@@ -52,12 +76,6 @@ If you prefer either a different database name, you can override the name using
5276
DATABASE_NAME=some_other_database bundle exec mdb-create-db
5377
```
5478

55-
## Documentation
56-
57-
See the Message DB documentation on the Eventide docs site:
58-
59-
[http://docs.eventide-project.org/user-guide/message-db/](http://docs.eventide-project.org/user-guide/message-db/)
60-
6179
## License
6280

6381
The `message-db` library is released under the [MIT License](https://github.com/eventide-project/message-db/blob/master/MIT-License.txt).

0 commit comments

Comments
 (0)