diff --git a/README.md b/README.md index 5622ef009..856abd613 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,13 @@ ## Why the fork -We have decided to fork the original `Faust` project because there is a critical process of releasing new versions which causes uncertainty in the community. Everybody is welcome to contribute to this `fork`, and you can be added as a manitainer. +We have decided to fork the original `Faust` project because there is a critical process of releasing new versions which causes uncertainty in the community. Everybody is welcome to contribute to this `fork`, and you can be added as a maintainer. We want to: - Ensure continues release - Code quality -- Use of latests versions of kafka drivers (for now only [aiokafka](https://github.com/aio-libs/aiokafka)) +- Use of latest versions of kafka drivers (for now only [aiokafka](https://github.com/aio-libs/aiokafka)) - Support kafka transactions - Update the documentation @@ -95,7 +95,7 @@ of "number of clicks from the last day," or we support tumbling, hopping and sliding windows of time, and old windows can be expired to stop data from filling up. -For reliability we use a Kafka topic as "write-ahead-log". +For reliability, we use a Kafka topic as "write-ahead-log". Whenever a key is changed we publish to the changelog. Standby nodes consume from this changelog to keep an exact replica of the data and enables instant recovery should any of the nodes fail. @@ -283,7 +283,7 @@ The following bundles are available: Aerospike can be enabled as the state store by specifying `store="aerospike://"` -By default all tables backed by Aerospike use `use_partitioner=True` and generate changelog topic events similar +By default, all tables backed by Aerospike use `use_partitioner=True` and generate changelog topic events similar to a state store backed by RocksDB. The following configuration options should be passed in as keys to the options parameter in [Table](https://fauststream.com/en/latest/reference/faust.tables.html) `namespace` : aerospike namespace