Skip to content

Commit e24b098

Browse files
committed
fix readme
1 parent 2f1dcf8 commit e24b098

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Glychee · A Simple Gleam Benchmark Runner on Erlang via Benchee
1+
# Glychee · A Simple Gleam Benchmark Runner on Erlang via Elixir's Benchee
22

33
[![Hex Package](https://img.shields.io/hexpm/v/glychee?color=ffaff3&label=%F0%9F%93%A6)](https://hex.pm/packages/glychee)
44
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3?label=%F0%9F%93%9A)](https://hexdocs.pm/glychee/)
55
[![License](https://img.shields.io/hexpm/l/glychee?color=ffaff3&label=%F0%9F%93%83)](https://github.com/inoas/glychee/blob/main/LICENSE)
66

77
A simple [Gleam](https://gleam.run) benchmark runner which wraps [**Benchee**](https://github.com/bencheeorg/benchee) for the heavy lifting.
88

9-
Named after *Gleam*, *Benchee* and their fruity [*Lychee*](https://en.wikipedia.org/wiki/Lychee) offspring:
9+
Named after _Gleam_, _Benchee_ and their fruity [_Lychee_](https://en.wikipedia.org/wiki/Lychee) offspring:
1010

1111
<figure>
1212
<img src="https://raw.githubusercontent.com/inoas/glychee/main/glychee-logo.jpg" alt="Glychee Logo" style="max-height: 33vh; width: auto; height: auto" width="480" height="480"/>
@@ -18,13 +18,13 @@ Named after *Gleam*, *Benchee* and their fruity [*Lychee*](https://en.wikipedia.
1818
- Requires **Gleam 1.0** or later.
1919
- For benchmarking on target JavaScript see <https://hex.pm/packages/gleamy_bench>,
2020
as Glychee only allows benchmarking on target Erlang.
21-
- Glychee is dependency free except for *Benchee* and *Elixir*.
21+
- Glychee is dependency free except for _Benchee_ and _Elixir_.
2222
- A recent Elixir and Hex must be installed. You might be required to run
2323
`mix local.hex` after installing Elixir.
2424

2525
## Quick start
2626

27-
1. Add ***Glychee*** to your project: `gleam add glychee --dev`.
27+
1. Add **_Glychee_** to your project: `gleam add glychee --dev`.
2828
2. Create a custom benchmarking module for example named `my_benchmark` that
2929
contains a `main`-function. In that module you will define which `Function`s
3030
to benchmark with one or many `Data`.

gleam.toml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name = "glychee"
2-
version = "1.1.1"
2+
version = "1.1.0"
33
gleam = "~> 1.0"
44
licences = ["Apache-2.0"]
5-
description = "Glychee · A Simple Gleam Benchmark Runner on Erlang via Benchee"
5+
description = "Glychee · A Simple Gleam Benchmark Runner on Erlang via Elixir's Benchee"
66
repository = { type = "github", user = "inoas", repo = "glychee" }
77
# links = [{ title = "Website", href = "https://gleam.run" }]
88
target = "erlang"
@@ -12,6 +12,6 @@ benchee = "~> 1.3"
1212

1313
[documentation]
1414
pages = [
15-
{ title = "CHANGELOG", path = "changelog.html", source = "CHANGELOG.md" },
16-
{ title = "LICENSE", path = "license.html", source = "LICENSE" },
15+
{ title = "CHANGELOG", path = "changelog.html", source = "CHANGELOG.md" },
16+
{ title = "LICENSE", path = "license.html", source = "LICENSE" },
1717
]

0 commit comments

Comments
 (0)