Skip to content

Update README.md #365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aravindputrevu merged 1 commit into from
May 22, 2024
Merged

Update README.md #365

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
<img src="https://img.shields.io/github/stars/middlewarehq/middleware?style=for-the-badge" alt="Stars" />
</p>

<!-- [Join our Engineering Leaders Community]() -->
Copy link
Member

@jayantbh jayantbh May 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aravindputrevu did you intend to leave this commented out for now and get this merged? OR should we wait for the link to be here?

Copy link
Contributor Author

@aravindputrevu aravindputrevu May 22, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Next PR once you approve 🙂


![Middleware Opensource](media_files/banner.gif)


Expand Down Expand Up @@ -44,17 +46,17 @@ They are:
- [Security guidelines](#%EF%B8%8F-security-guidelines)
- [License](#license)

# 🚀 Features
## 🚀 Features

- Integration with various CI/CD tools
- Automated collection and analysis of DORA metrics
- Visualization of key performance indicators
- Customizable reports and dashboards
- Integration with popular project management platforms

# ✨ Quick Start
## ✨ Quick Start

## ⭐ Installing Middleware
### ⭐ Installing Middleware
* Ensure that you have [docker](https://www.docker.com/products/docker-desktop/) installed and running.

* Open the terminal and run the following command:
Expand Down Expand Up @@ -100,9 +102,9 @@ They are:
```


# 👩‍💻 Developer Setup
## 👩‍💻 Developer Setup

## ☁️ Using GitPod
### ☁️ Using GitPod

Gitpod enables development on remote machines and helps you get started with Middleware if your machine does not support running the project locally.

Expand All @@ -116,7 +118,7 @@ If you want to run the project locally you can [setup using docker](#-using-dock

After initialization, you can access the server at port 3333 of the gitpod instance.

## 🐳 Using Docker
### 🐳 Using Docker

If you don't have docker installed, please install docker [over here](https://docs.docker.com/get-docker/).
Make sure docker is running.
Expand Down Expand Up @@ -352,11 +354,11 @@ For simplicity, we synchronize your Pull Request data and classify reverted Pull
- Deployments that can be linked to any incident are considered as causing a failure or outage.
- The fraction of deployments causing outages to the total deployments in an interval is used to determine the CFR.

# 🛣️ Roadmap
## 🛣️ Roadmap

Coming Soon!

# ❤️ Contributing guidelines
## ❤️ Contributing guidelines

![contributor Metrics](https://open-source-assets.middlewarehq.com/svgs/middlewarehq-middleware-contributor-metrics-dark-widget-premium.svg)

Expand All @@ -371,7 +373,7 @@ To get started contributing to middleware check out our [SECURITY.md](https://gi
We look forward to your part in keeping Middleware secure!


# License
## License

This project is licensed under the [Apache 2.0](https://github.com/middlewarehq/middleware/blob/main/LICENSE) License - see the LICENSE.md file for details.

Expand Down