Skip to content

Commit

Permalink
Merge pull request #20 from Workable/features/add_installation_exampl…
Browse files Browse the repository at this point in the history
…e_in_readme

Add a readme section with installation instructions
  • Loading branch information
sque authored Sep 8, 2017
2 parents 93d250b + 2240338 commit a327f34
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ at microservices. A common usage scenario is to inject the request_id in the log
even those emitted by third party libraries, have attached the request_id that initiated their call. This can
greatly improve tracing and debugging of problems.

## Installation

The easiest way to install it is using ``pip`` from PyPI

```bash
pip install flask-log-request-id
```

## Usage

Flask-Log-Request-Id provides the `current_request_id()` function which can be used at any time to get the request
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def index():
Installation
------------
The easier way to install it is using ``pip`` from PyPI
The easiest way to install it is using ``pip`` from PyPI
.. code:: bash
Expand Down

0 comments on commit a327f34

Please sign in to comment.