Improve README documentation - #87
Merged
Merged
Conversation
Correct `Postgres.event_store` to `Postgres.config.event_store` (the accessor lives on Config, not the module) and fix the unbalanced braces in the `sink` call.
Document the Ruby and PostgreSQL prerequisites, and the `uuid-ossp` and `pg_json` extensions the event store depends on.
Add an introductory line linking to the EventSourcery gem so readers have context for what this adapter plugs into.
Note the MIT license and link to LICENSE.txt.
Add a section covering `Schema.create_event_store` and `Schema.create_projector_tracker`, the required setup step that was previously missing entirely.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improves the README to fix an incorrect example and fill in missing documentation.
Changes
Postgres.event_storetoPostgres.config.event_store(the accessor lives onConfig, not the module) and fixed unbalanced braces in thesinkcall.Schema.create_event_storeandSchema.create_projector_tracker, the required setup step that was previously missing entirely.uuid-ossp/pg_jsonextensions.event_sourcerygem for context.