From 1c960c8bca5570daf02ad6d22f46357808f7c305 Mon Sep 17 00:00:00 2001 From: Yannick Meeus Date: Wed, 22 May 2019 16:11:16 +0300 Subject: [PATCH] docs(readme): Re-ordered usage and install to make a bit more sense --- README.md | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 6898a888..349dd57a 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,32 @@ The goal of Event-Sauced is to be provide a database-agnostic API for an event s - Provide data consistency and concurrency support in all supported engines ## Documentation + The documentation is currently hosted on GitHub pages, and can be found [here](https://yannickmeeus.github.io/event-sauced-ts/). It might not look the prettiest, but I can guarantee it's at least a little bit accurate. +## Install + +### Core library + +With [npm](https://npmjs.org/) installed, run + +```sh +npm install @make-stuff-work/event-sauced +``` + +### Data Storage Engines + +With [npm](https://npmjs.org/) installed, run + +```sh +npm install @make-stuff-work/event-sauced-cosmosdb +npm install @make-stuff-work/event-sauced-postgresql +npm install @make-stuff-work/event-sauced-dynamodb +... +``` + + ## Usage ```js @@ -82,26 +105,6 @@ const eventStore = new e.EventStore(storageEngine); ``` -## Install - -## Core library - -With [npm](https://npmjs.org/) installed, run - -```sh -$ npm install event-sauced -``` - -### Data Storage Engines - -With [npm](https://npmjs.org/) installed, run - -```sh -$ npm install event-sauced-dynamodb -$ npm install event-sauced-cosmosdb -$ npm install event-sauced-postgresql -... -``` ## License