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

added bookdown.io documentation #13

Merged
merged 1 commit into from Nov 10, 2015
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Expand Up @@ -5,3 +5,4 @@
.idea
nbproject
composer.lock
docs/html
26 changes: 22 additions & 4 deletions README.md
Expand Up @@ -12,21 +12,39 @@ This package acts as a glue component between [prooph/service-bus](https://githu
- [Transaction handling](docs/transaction_manager.md) based on command dispatch
- [Event publishing](docs/event_publisher.md) after event store commit

# Support
## Documentation

Documentation is [in the doc tree](docs/), and can be compiled using [bookdown](http://bookdown.io) and [Docker](https://www.docker.com/)

```console
$ docker run -it --rm -v $(pwd):/app sandrokeil/bookdown docs/bookdown.json
$ docker run -it --rm -p 8080:8080 -v $(pwd):/app php:5.6-cli php -S 0.0.0.0:8080 -t /app/docs/html
```

or make sure bookdown is installed globally via composer and `$HOME/.composer/vendor/bin` is on your `$PATH`.

```console
$ bookdown docs/bookdown.json
$ php -S 0.0.0.0:8080 -t docs/html/
```

Then browse to [http://localhost:8080/](http://localhost:8080/)

## Support

- Ask questions on [prooph-users](https://groups.google.com/forum/?hl=de#!forum/prooph) mailing list.
- File issues at [https://github.com/prooph/event-store-bus-bridge/issues](https://github.com/prooph/event-store-bus-bridge/issues).
- Say hello in the [prooph gitter](https://gitter.im/prooph/improoph) chat.

# Contribute
## Contribute

Please feel free to fork and extend existing or add new plugins and send a pull request with your changes!
To establish a consistent code quality, please provide unit tests for all your changes and may adapt the documentation.

# Dependencies
## Dependencies

Please refer to the project [composer.json](composer.json) for the list of dependencies.

# License
## License

Released under the [New BSD License](LICENSE).
3 changes: 2 additions & 1 deletion composer.json
Expand Up @@ -29,7 +29,8 @@
"container-interop/container-interop": "^1.1",
"phpunit/phpunit": "~4.8",
"fabpot/php-cs-fixer": "1.7.*",
"satooshi/php-coveralls": "dev-master"
"satooshi/php-coveralls": "dev-master",
"tobiju/bookdown-bootswatch-templates": "1.0.x-dev"
},
"autoload": {
"psr-4": {
Expand Down
10 changes: 10 additions & 0 deletions docs/bookdown.json
@@ -0,0 +1,10 @@
{
"title": "Marry CQRS with Event Sourcing",
"content": [
{"intro": "../README.md"},
{"event_publisher": "event_publisher.md"},
{"transaction_manager": "transaction_manager.md"}
],
"target": "./html",
"template": "../vendor/tobiju/bookdown-bootswatch-templates/templates/cerulean/main.php"
}