Skip to content

Commit c87a469

Browse files
committed
readme update
1 parent 55ffd67 commit c87a469

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,10 @@ agent = stackimpact.start(
6868

6969
Add the agent initialization to the worker code, e.g. wsgi.py, if applicable.
7070

71-
Other initialization options:
71+
All initialization options:
7272

73+
* `agent_key` (Required) The access key for communication with the StackImpact servers.
74+
* `app_name` (Required) A name to identify and group application data. Typically, a single codebase corresponds to one application.
7375
* `app_version` (Optional) Sets application version, which can be used to associate profiling information with the source code release.
7476
* `app_environment` (Optional) Used to differentiate applications in different environments.
7577
* `host_name` (Optional) By default, host name will be the OS hostname.

README.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Getting started
5555
Create StackImpact account
5656
^^^^^^^^^^^^^^^^^^^^^^^^^^
5757

58-
Sign up for a free account at
59-
`stackimpact.com <https://stackimpact.com/>`__.
58+
`Sign up <https://dashboard.stackimpact.com/#/signup>`__ for a free
59+
account (also with GitHub login).
6060

6161
Installing the agent
6262
^^^^^^^^^^^^^^^^^^^^
@@ -89,8 +89,12 @@ Configuration section.
8989
Add the agent initialization to the worker code, e.g. wsgi.py, if
9090
applicable.
9191

92-
Other initialization options:
92+
All initialization options:
9393

94+
- ``agent_key`` (Required) The access key for communication with
95+
StackImpact servers.
96+
- ``app_name`` (Required) A name to identify and group application
97+
data. Typically, single codebase corresponds to one application.
9498
- ``app_version`` (Optional) Sets application version, which can be
9599
used to associate profiling information with the source code release.
96100
- ``app_environment`` (Optional) Used to differentiate applications in

0 commit comments

Comments
 (0)