diff --git a/README.md b/README.md index 9400fca..088ba4e 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,6 @@ in both realtime and batch jobs. ## Key Features - - Works in **real time** (eg: reading from kafka) and **replay mode** (eg: reading from parquet) - Optimized for analytics, it uses micro-batching (instead of processing records one by one) - Similar to [incremental][3], it updates nodes in a dag incrementally @@ -31,7 +30,6 @@ in both realtime and batch jobs. So the same dag can be used in real time mode, replay mode or can be easily tested. - Functional interface: no inheritance or decorator required - [1]: https://github.com/tradewelltech/beavers [2]: https://www.tradewelltech.co/ [3]: https://github.com/janestreet/incremental diff --git a/docs/index.md b/docs/index.md index bec79f3..d2a5300 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ +![Beavers Logo][5] + # Beavers [Beavers][1] is a python library for stream processing, optimized for analytics. @@ -8,7 +10,6 @@ in both realtime and batch jobs. ## Key Features - - Works in **real time** (eg: reading from kafka) and **replay mode** (eg: reading from parquet) - Optimized for analytics, it uses micro-batching (instead of processing records one by one) - Similar to [incremental][3], it updates nodes in a dag incrementally @@ -19,8 +20,8 @@ in both realtime and batch jobs. So the same dag can be used in real time mode, replay mode or can be easily tested. - Functional interface: no inheritance or decorator required - [1]: https://github.com/tradewelltech/beavers [2]: https://www.tradewelltech.co/ [3]: https://github.com/janestreet/incremental [4]: https://www.confluent.io/blog/kafka-streams-tables-part-1-event-streaming/ +[5]: ./static/icons/beavers/logo.svg diff --git a/docs/static/icons/beavers/icon.png b/docs/static/icons/beavers/icon.png index deb0c4d..107e645 100644 Binary files a/docs/static/icons/beavers/icon.png and b/docs/static/icons/beavers/icon.png differ diff --git a/docs/static/icons/beavers/logo.svg b/docs/static/icons/beavers/logo.svg index 5d891de..d2f81d8 100644 --- a/docs/static/icons/beavers/logo.svg +++ b/docs/static/icons/beavers/logo.svg @@ -1,73 +1,25 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/mkdocs.yml b/mkdocs.yml index e02360f..78a4cae 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -38,5 +38,7 @@ markdown_extensions: - pymdownx.snippets: - pymdownx.emoji - pymdownx.highlight + - attr_list + - md_in_html extra: project_name: "beavers"