changed CHANGELOG.md
 
@@ -2,6 +2,11 @@
2
2
3
3
<!-- %% CHANGELOG_ENTRIES %% -->
4
4
5
+ ### 0.2.1 - 2021-07-05 00:20:48
6
+
7
+ Improved docs.
8
+
9
+
5
10
### 0.2.0 - 2021-07-05 00:00:02
6
11
7
12
First public version.
changed README.md
 
@@ -3,6 +3,13 @@
3
3
4
4
Easy profiling for your Phoenix controller actions (and other functions) using [flamegraphs](http://www.brendangregg.com/flamegraphs.html).
5
5
6
+ #### Example flamegraph
7
+
8
+ <link rel="stylesheet" href="doc_extra/assets/incendium.css" />
9
+ <script src="doc_extra/assets/incendium.js" charset="utf-8"></script>
10
+
11
+ <script type="text/javascript" src="doc_extra/assets/incendium_flamegraph_hkctthqlqhcubcsgrazymmvaldzllxbq.js"></script>
12
+
6
13
## Installation
7
14
8
15
The package can be installed
 
@@ -11,7 +18,7 @@ by adding `incendium` to your list of dependencies in `mix.exs`:
11
18
```elixir
12
19
def deps do
13
20
[
14
- {:incendium, "~> 0.1.0"}
21
+ {:incendium, "~> x.y.z"}
15
22
]
16
23
end
17
24
```
 
@@ -43,7 +50,7 @@ To use `incendium` in your web application, you need to follow these steps:
43
50
```elixir
44
51
def deps do
45
52
[
46
- {:incendium, "~> 0.1.0"}
53
+ {:incendium, "~> 0.2.0"}
47
54
]
48
55
end
49
56
```
 
@@ -112,3 +119,5 @@ In the future we may support better options such as sampling profilers.
112
119
Each time you run a profiled function, a new stacktrace will be generated.
113
120
Stacktraces are not currently saves, you can only access the latest one.
114
121
In the future we might add a persistence layer that stores a number of stacktraces instead of keeping just the last one.
122
+
123
+ [Here](https://hexdocs.pm/incendium/example-flamegraph.html) you can find an example flamegraph with explanations about how to interact with it .
\ No newline at end of file
changed hex_metadata.config
 
@@ -44,4 +44,4 @@
44
44
{<<"optional">>,false},
45
45
{<<"repository">>,<<"hexpm">>},
46
46
{<<"requirement">>,<<"~> 1.0">>}]]}.
47
- {<<"version">>,<<"0.2.0">>}.
47
+ {<<"version">>,<<"0.2.1">>}.
changed lib/incendium.ex
 
@@ -1,11 +1,17 @@
1
1
defmodule Incendium do
2
+ @external_resource "README.md"
3
+
2
4
readme_part =
3
5
"README.md"
4
6
|> File.read!()
5
7
|> String.split("<!-- ex_doc -->")
6
8
|> Enum.at(1)
7
9
8
- @moduledoc readme_part
10
+ @moduledoc """
11
+ Easy flamegraphs to profile for your web applications.
12
+
13
+ #{readme_part}
14
+ """
9
15
10
16
alias Incendium.Storage
changed mix.exs
 
@@ -1,12 +1,13 @@
1
1
defmodule Incendium.MixProject do
2
2
use Mix.Project
3
3
4
- @version "0.2.0"
4
+ @version "0.2.1"
5
5
@url "https://github.com/tmbb/incendium"
6
6
7
7
def project do
8
8
[
9
9
app: :incendium,
10
+ name: "Incendium",
10
11
description: "Easy flamegraphs for your web application",
11
12
version: @version,
12
13
source_url: @url,
 
@@ -22,7 +23,11 @@ defmodule Incendium.MixProject do
22
23
}
23
24
],
24
25
docs: [
25
- extras: ["doc_extra/pages/Example flamegraph.md"],
26
+ main: "Incendium",
27
+ extras: [
28
+ # Don't add a README; add usage instructions to the main module instead
29
+ "doc_extra/pages/Example flamegraph.md"
30
+ ],
26
31
assets: "doc_extra/assets/"
27
32
]
28
33
]