Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure docs #109

Merged
merged 3 commits into from
Oct 14, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
.php_cs.cache
nbproject
composer.lock
docs/html
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ If you want to use the projections, run additionally the scripts `scripts/mariad
Introduction
------------

[Video](https://www.youtube.com/watch?v=QhpDIqYQzg0)
[![Prooph Event Store v7](https://img.youtube.com/vi/QhpDIqYQzg0/0.jpg)](https://www.youtube.com/watch?v=QhpDIqYQzg0)

Tests
-----
Expand Down
10 changes: 6 additions & 4 deletions docs/bookdown.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
{
"title": "Prooph EventStore",
"title": "PDO Event Store",
"content": [
{"intro": "../README.md"},
{"event_store": "pdo_event_store.md"},
{"intro": "introduction.md"},
{"variants": "variants.md"},
{"interop_factories": "interop_factories.md"}
],
"tocDepth": 1,
"numbering": false,
"target": "./html",
"template": "../vendor/tobiju/bookdown-bootswatch-templates/templates/main.php"
"template": "../vendor/prooph/bookdown-template/templates/main.php"
}
37 changes: 37 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Introduction

The PDO Event Store is an implementation of [prooph/event-store](https://github.com/prooph/event-store) that supports
MySQL and MariaDB as well as PostgreSQL.

## Video Introduction

[![Prooph Event Store v7](https://img.youtube.com/vi/QhpDIqYQzg0/0.jpg)](https://www.youtube.com/watch?v=QhpDIqYQzg0)

## Installation

```php
composer require prooph/pdo-event-store
```

## Requirements

- PHP >= 7.1
- PDO_MySQL Extension or PDO_PGSQL Extension

For MariaDB you need server vesion >= 10.2.6.
For MySQL you need server version >= 5.7.9.
For Postgres you need server version >= 9.4.

## Setup

For MariaDB run the script in `scripts/mariadb/01_event_streams_table.sql` on your server.

For MySQL run the script in `scripts/mysql/01_event_streams_table.sql` on your server.

For Postgres run the script in `scripts/postgres/01_event_streams_table.sql` on your server.

This will setup the required event streams table.

If you want to use the projections, run additionally the scripts `scripts/mariadb/02_projections_table.sql`
(for MariaDB), `scripts/mysql/02_projections_table.sql` (for MySQL) or
`scripts/postgres/02_projections_table.sql` (for Postgres) on your server.
4 changes: 2 additions & 2 deletions docs/pdo_event_store.md → docs/variants.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Prooph PDO Event Store
# Variants

The PDO Event Store is an implementation of [prooph/event-store](https://github.com/prooph/event-store) that supports
MySQL as well as PostgreSQL.
MySQL and MariaDB as well as PostgreSQL.

For a better understanding, we recommend to read the event-store docs, first.

Expand Down