Skip to content

Commit 70954b9

Browse files
committed
updates README with 2 step install process
1 parent 8f85bb4 commit 70954b9

File tree

1 file changed

+24
-8
lines changed

1 file changed

+24
-8
lines changed

README.md

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,35 @@ Pyroscope is an open source continuous profiling platform. It will help you:
4343
* Efficient compression, low disk space requirements
4444
* Snappy UI
4545

46-
## Documentation
46+
## Installation
4747

48-
To install pyroscope on a mac:
48+
#### on macOS:
4949
```shell
5050
brew install pyroscope-io/brew/pyroscope
5151
```
52+
## Try Pyroscope Locally
5253

53-
To install the docker image:
54+
### Step 1 — Start Pyroscope Server
55+
56+
#### on macOS / Linux:
57+
```shell
58+
pyroscope server
59+
```
60+
61+
#### with Docker:
5462
```shell
55-
docker pull pyroscope/pyroscope:latest
63+
docker run -it -p 4040:4040 pyroscope/pyroscope:latest server
5664
```
5765

58-
After pyroscope is installed, you just need to:
59-
1. Start the pyroscope server (`pyroscope server` or `docker run -it pyroscope/pyroscope:latest server`)
60-
2. Run your application with the right agent (see image below). For more information on this, see our [Getting Started guide](https://pyroscope.io/docs/#profile-your-applications).
66+
### Step 2 — Profile Your Application
6167

62-
![Deployment Diagram](.github/markdown-images/deployment.svg)
68+
Add `pyroscope exec` before the command you use to start your app:
69+
70+
```
71+
pyroscope exec python manage.py runserver
72+
```
73+
74+
### More Documentation
6375

6476
For information on how to install it on Linux or use it in production environment check out our documentation:
6577

@@ -68,6 +80,10 @@ For information on how to install it on Linux or use it in production environmen
6880
* [Developer Guide](https://pyroscope.io/docs/developer-guide)
6981

7082

83+
## Deployment Diagram
84+
85+
![Deployment Diagram](.github/markdown-images/deployment.svg)
86+
7187
## Downloads
7288

7389
You can download the latest version of pyroscope for macOS, linux and Docker from our [Downloads page](https://pyroscope.io/downloads/).

0 commit comments

Comments
 (0)