Merge pull request #4 from last9/update-readme

Update README.md

README.md

@@ -2,54 +2,46 @@
 
 # Awesome Prometheus Toolkit
 
-_The most apt alert rules toolkit for your Prometheus setup._
+_The most apt toolkit for your Prometheus setup._
 
-Connect your Prometheus setup. Discover components emitting metrics. Get recommendations of rules to be applied.
+Kickstarting your monitoring journey with Prometheus is a broken experience and one struggles with a standardized set of components, alerting rules, and dashboards to use. APT aims to build a standardized resource across the instrumentation, query, and alerting pipelines.
 
-Currently supported components:
+With the v0.1 of Awesome Prometheus Toolkit, we are setting a foundation for an amazing Prometheus developer experience we want:
 
-- Kubernetes
-- Nginx
-- PostgreSQL
+1. You point APT to your running Prometheus server
+2. APT identifies which components are sending metrics to Prometheus
+3. APT gives recommendations on what alert rules (sourced from [awesome-prometheus-alerts](https://github.com/samber/awesome-prometheus-alerts)) should be applied
 
-## 📝 Convention
+Read our launch blog post [here](https://last9.io/blog/announcing-awesome-prometheus-toolkit).
 
-- [Gitmoji](https://gitmoji.dev/) for commits
-- [npm](https://npm.io/) as package manager
+[![Demo of Awesome Prometheus Toolkit](https://github.com/last9/awesome-prometheus-toolkit/assets/1834234/b0ed8f22-f2f2-4a3f-a8bb-76bd00753681)](https://www.youtube.com/watch?v=yFqCdkc23Gc)
 
-## 💻 Getting Started
-
-1. Install dependencies
+Currently, APT gives you recommendations and tracks which rules are already applied for the following components:
 
-   ```bash
-   npm install
-   ```
+1. Clickhouse
+2. Elasticsearch
+3. HaProxy
+4. Kubernetes
+5. Nginx
+6. PostgreSQL
 
-2. Run the dev server
-
-   ```bash
-   npm run dev
-   ```
+## 💻 Getting Started
 
-Open [http://localhost:3000](http://localhost:3000) in your browser.
+1. Run `npm install` to install the dependencies
+2. Run `npm run dev` to run the dev server
+3. Open `localhost:3000` in your browser
+4. Enter the URL of your local/test/production Prometheus server, and click Connect
+   - You can also set the auth, if your server requires it
+5. Once APT identifies the supported components in your emitted metrics, you can view the recommendations. You can simply copy the recommended rules and apply them in your Prometheus’ `rules.yml`
+6. If you have any additional components, you can also use the Browse Library section to find and copy those rules
 
 ## 🔧 Setup Demo Prometheus Server (Optional)
 
-You can spin up a prometheus server with Nginx and some alerts locally to test APT. Here's how:
-
-1. Navigate to prometheus-server
-
-   ```bash
-   cd prometheus-server
-   ```
-
-2. Start the local prometheus server
-
-   ```bash
-   docker compose up
-   ```
+If you don’t have a Prometheus server handy but still want to play around with APT, you can also use the demo setup provided in the repo to generate metrics for the supported components (except Kubernetes).
 
-You can now access [http://localhost:9090](http://localhost:9090) through APT.
+1. Run `cd promtheus-server`
+2. Run `docker compose up` to start the local server
+3. Use `localhost:9090` as the source URL on the APT home screen, without any required auth
 
 ## About Last9