Skip to content

Commit a059050

Browse files
committed
improves readme with simpler instructions
1 parent a0e3cb5 commit a059050

File tree

1 file changed

+7
-21
lines changed

1 file changed

+7
-21
lines changed

README.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -42,38 +42,24 @@ Pyroscope is an open source continuous profiling platform. It will help you:
4242
* Low CPU overhead
4343
* Efficient compression, low disk space requirements
4444
* Snappy UI
45+
* Support for Go, Ruby and Python
4546

46-
## Installation
47+
## Try pyroscope locally in 3 steps:
4748

48-
#### on macOS:
4949
```shell
50+
# install pyroscope
5051
brew install pyroscope-io/brew/pyroscope
51-
```
52-
## Try Pyroscope Locally
53-
54-
### Step 1 — Start Pyroscope Server
5552

56-
#### on macOS / Linux:
57-
```shell
53+
# start pyroscope server:
5854
pyroscope server
59-
```
60-
61-
#### with Docker:
62-
```shell
63-
docker run -it -p 4040:4040 pyroscope/pyroscope:latest server
64-
```
65-
66-
### Step 2 — Profile Your Application
6755

68-
Add `pyroscope exec` before the command you use to start your app:
69-
70-
```
56+
# in a separate tab, start profiling your app:
7157
pyroscope exec python manage.py runserver
7258
```
7359

74-
### More Documentation
60+
## Documentation
7561

76-
For information on how to install it on Linux or use it in production environment check out our documentation:
62+
For more information on how to use Pyroscope with other programming languages, install it on Linux or use it in production environment check out our documentation:
7763

7864
* [Getting Started](https://pyroscope.io/docs/)
7965
* [Deployment Guide](https://pyroscope.io/docs/deployment)

0 commit comments

Comments
 (0)