Skip to content

Commit

Permalink
docs(readme): Re-ordered usage and install to make a bit more sense (#…
Browse files Browse the repository at this point in the history
…157)

docs(readme): Re-ordered usage and install to make a bit more sense
  • Loading branch information
YannickMeeus authored May 22, 2019
2 parents 31a3af5 + 1c960c8 commit 096dbac
Showing 1 changed file with 23 additions and 20 deletions.
43 changes: 23 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 096dbac

Please sign in to comment.