From aef3e65bda1849e72b14b67181cf49ec3ed6aded Mon Sep 17 00:00:00 2001 From: idanasulinStrech Date: Sun, 24 Jul 2022 22:02:50 +0300 Subject: [PATCH] readme update --- README.md | 127 ++------------------------------------------------- package.json | 2 +- 2 files changed, 5 insertions(+), 124 deletions(-) diff --git a/README.md b/README.md index 1f8657d..88776b5 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@
-

Probably The Easiest Message Broker In The World

+

A Powerful Messaging Platform For Devs

@@ -20,131 +20,12 @@

-Discord Code Of Conduct License GitHub release (latest by date) +Discord Code Of Conduct License GitHub release (latest by date)

-**[Memphis{dev}](https://memphis.dev)** is a message broker for developers made out of devs' struggles develop around message brokers.
Enables devs to achieve all other message brokers' benefits in a fraction of the time.
+**[Memphis{dev}](https://memphis.dev)** is a Go-based message broker for developers made out of devs' struggles develop around message brokers.
Enables devs to achieve all other message brokers' benefits in a fraction of the time.
Focusing on automatic optimization, schema management, inline processing, and troubleshooting abilities. All under the same hood. - -## ⭐️ Why -Building an event-driven application is HARD.
-As a developer, you need to build a dedicated pipeline per data source,
change the schema, individual analysis, enrich the data with other sources, it crashes, adapt to different rate limits, constantly change APIs, and scale for better performance 🥵 .
-**It takes time that you don't have.**

-Message broker is the answer. It allows you to build an architecture that supports such a pattern,
but then you encounter Apache Kafka and its documentation and run back to the monolith and batch jobs.
-Give memphis{dev} a spin before. - -## 👉 Use-cases -- Async task management -- Real-time streaming pipelines -- Data ingestion -- Async communication between services on k8s -- Queuing -- Multiple destinations to a single message - -## ✨ Features - -**v0.2.2** - -- 🚀 Fully optimized message broker in under 3 minutes -- 💻 Easy-to-use UI, CLI, and SDKs -- 📺 Data-level observability -- 🐳☸Runs on your Docker or Kubernetes -- 👨‍💻 Community driven - -**Coming soon v0.2.5-1.0.0** -- Embedded schema registry using dbt -- Message Journey - Real-time messages tracing -- More SDKs (GoLang, Python, Kafka compatible) -- Inline processing -- Ready-to-use connectors and analysis functions - -## 📸 Screenshots -Dashboard | Station overview| CLI -:-------------------------:|:-------------------------:|:-------------------------: -drawing|drawing|drawing - - - -## 🚀 Getting Started -[Installation videos](https://www.youtube.com/playlist?list=PL_7iYjqhtXpWpZT2U0zDYo2eGOoGmg2mm)

-Helm for Kubernetes -```shell -helm repo add memphis https://k8s.memphis.dev/charts/ && \ -helm install my-memphis memphis/memphis --create-namespace --namespace memphis -``` -Docker Compose -```shell -curl -s https://memphisdev.github.io/memphis-docker/docker-compose.yml -o docker-compose.yml && \ -docker compose -f docker-compose.yml -p memphis up -``` -[![Connect your first app](https://img.youtube.com/vi/-5YmxYRQsdw/0.jpg)](https://www.youtube.com/watch?v=PL_7iYjqhtXpWpZT2U0zDYo2eGOoGmg2mm)
-[Tutorial: Build an event-driven food delivery app](https://medium.com/memphis-dev/how-to-build-your-own-wolt-app-b220d738bb71) - -## High-Level Architecture -memphis.dev-logo - -## Local access -### Via Kubernetes -```shell -To access Memphis UI from localhost, run the below commands: - 1. kubectl port-forward service/memphis-ui 9000:80 --namespace memphis > /dev/null & - -To access Memphis using CLI or SDK from localhost, run the below commands: - 2. kubectl port-forward service/memphis-cluster 7766:7766 6666:6666 5555:5555 --namespace memphis > /dev/null & - -Dashboard: http://localhost:9000 -Memphis broker: localhost:5555 (Management Port) / 7766 (Data Port) / 6666 (TCP Port) -``` -**For Production Environments** -Please expose the UI, Cluster, and Control-plane via k8s ingress / load balancer / nodeport - -### Via Docker -Dashboard - http://localhost:9000
-Broker - localhost:7766
-Control-Plane - localhost:5555/6666
- -## Beta -Memphis{dev} is currently in Beta version. This means that we are still working on essential features like real-time messages tracing,
-Schema registry, and inline processing, as well as making more SDKs and supporting materials. - -How does it affect you? Well... mostly it doesn't.
-(a) The core of memphis broker is highly stable
-(b) We learn&fix fast

-But we need your love, and any help we can get by stars, PR, feedback, issues, and enhancments.
-Read more on https://memphis.dev/docs - -## Support - -### Ask a question about Memphis{dev} or related - -You can ask questions, and participate in discussions about Memphis{dev}-related topics in the Memphis Discord channel. - - - -### Create a bug report - -If you see an error message or run into an issue, please [create bug report](https://github.com/memphisdev/memphis-broker/issues/new?assignees=&labels=type%3A%20bug&template=bug_report.md&title=). This effort is valued and it will help all Memphis{dev} users. - - -### Submit a feature request - -If you have an idea, or you're missing a capability that would make development easier and more robust, please [Submit feature request](https://github.com/memphisdev/memphis-broker/issues/new?assignees=&labels=type%3A%20feature%20request). - -If a similar feature request already exists, don't forget to leave a "+1". -If you add some more information such as your thoughts and vision about the feature, your comments will be embraced warmly :) - -## Contributing - -Memphis{dev} is an open-source project.
-We are committed to a fully transparent development process and appreciate highly any contributions.
-Whether you are helping us fix bugs, proposing new features, improving our documentation or spreading the word -
we would love to have you as part of the Memphis{dev} community. - -Please refer to our [Contribution Guidelines](./CONTRIBUTING.md) and [Code of Conduct](./code_of_conduct.md). - -## Contributors ✨ - -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

- +Utilizing NATS core. ## Installation diff --git a/package.json b/package.json index 5e3da2e..fbbebce 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "memphis-dev", - "version": "0.3.6", + "version": "0.3.7", "description": "A dev-first event processing platform", "main": "lib/index.js", "types": "lib/index.d.ts",