Skip to content

Commit

Permalink
Updated installing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
oskardudycz committed Feb 11, 2024
1 parent 3e164ed commit 6cc79d5
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 16 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ This project aims to experiment with an opinionated Event Sourcing framework bas

### **Is it production-ready?**

Nope.
Kinda. What is here is already usable, but you'll need to wait for the full production experience in all essential aspects.

### **Will it be?**
### **Will it be production-ready?**

Maybe.
Hopefully.

### **Why Node.js?**

Expand All @@ -32,28 +32,34 @@ I like its minimalistic approach and flexibility, plus TypeScript is an excellen

### **What features it has?**

Currently, none, but that will change.
Essential building blocks for designing and running business and application logic like:

- typings around events, commands, Deciders, Workflows, etc.
- command handling wrappers for application layer,
- basic, in-memory event store implementation.

### **What features will it have?**

We'll see, but for sure, I'd like to have the following:

- atomicity of the stream append operations,
- reading your writes,
- subscriptions based on Postgres logical replications,
- Postgres partitioning,
- building blocks for the Web Apis with Event Sourcing and CQRS,
- implementation of event store using EventStoreDB, PostgreSQL, SQLite, etc.
- abstractions for building read models,
- building blocks for integration and running distributed processes,
- GraphQL API for event stores,
- Full stack development helpers with Next.js or HTMX,
- running it serverless or on the web with SQLite,
- streaming data through HTTP API (and enabling integration scenarios through it).
- defining event transformations and projections with WebAssembly,
- build-in read models based on the JSON capabilities of Postgres and SQLite.
- etc.

### **Would it be a competitor to other stores?**

Probably not. For now, I'd like to have a safe playground to have fun and try out new ideas. Still, what I deliver, I expect to be safe to use on a small scale.
Probably not. For now, I'd like to have a safe playground to have fun, experiment and try out new ideas. Still, I expect what I deliver to be safe to use in production.

### **Why there's no license?**

Because I'm unsure when this will end, and I don't want to expose it as an MIT license from the beginning.
Because I'm unsure how this will end, and I don't want to expose it as an MIT license from the beginning.

## Support

Expand Down
8 changes: 4 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ I assume that you have Node.js installed. Add the package from the terminal usin
::: code-group

```sh [npm]
$ npm add -D @event-driven-io/emmett
$ npm add @event-driven-io/emmett
```

```sh [pnpm]
$ pnpm add -D @event-driven-io/emmett
$ pnpm add @event-driven-io/emmett
```

```sh [yarn]
$ yarn add -D @event-driven-io/emmett
$ yarn add @event-driven-io/emmett
```

```sh [bun]
$ bun add -D @event-driven-io/emmett
$ bun add @event-driven-io/emmett
```

:::
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6cc79d5

Please sign in to comment.