Skip to content

Commit 5be8219

Browse files
inoasinoas
authored andcommitted
fix readme
1 parent d5b73c5 commit 5be8219

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# 🏎️ Glychee Benchmark · Simple Gleam Benchmarking on Erlang via Elixir's Benchee
22

3-
[![Package <a href="https://github.com/inoas/glychee/releases"><img src="https://img.shields.io/github/release/inoas/glychee" alt="GitHub release"></a> Version](https://img.shields.io/hexpm/v/given)](https://hex.pm/packages/given)
3+
[![Downloads](https://img.shields.io/hexpm/dt/glychee)](https://hex.pm/packages/glychee)
44
[![Erlang-compatible](https://img.shields.io/badge/target-erlang-b83998)](https://www.erlang.org/)
5-
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/given/)
5+
[![JavaScript Compatible](https://img.shields.io/badge/target-javascript-f3e155)](https://en.wikipedia.org/wiki/JavaScript)
6+
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/glychee/)
7+
[![Package <a href="https://github.com/inoas/gleam-glychee/releases"><img src="https://img.shields.io/github/release/inoas/gleam-glychee" alt="GitHub release"></a> Version](https://img.shields.io/hexpm/v/glychee)](https://hex.pm/packages/glychee)
8+
[![CI Test](https://github.com/inoas/gleam-glychee/actions/workflows/test.yml/badge.svg?branch=main&amp;event=push)](https://github.com/inoas/gleam-glychee/actions/workflows/test.yml)
9+
[![License](https://img.shields.io/hexpm/l/glychee)](https://github.com/inoas/gleam-glychee/blob/main/LICENCE)
610
[![Discord](https://img.shields.io/discord/768594524158427167?label=discord%20chat&amp;color=5865F2)](https://discord.gg/Fm8Pwmy)
7-
[![CI Test](https://github.com/inoas/glychee/actions/workflows/test.yml/badge.svg?branch=main&amp;event=push)](https://github.com/inoas/glychee/actions/workflows/test.yml)
11+
12+
<br>
13+
<br>
814

915
A simple [Gleam](https://gleam.run) benchmark runner which wraps
1016
[**Benchee**](https://github.com/bencheeorg/benchee) for the heavy lifting.
@@ -21,7 +27,8 @@ Named after _Gleam_, _Benchee_ and their fruity [_Lychee_](https://en.wikipedia.
2127
- Requires **Gleam 1.0** or later.
2228
- For benchmarking on target JavaScript see <https://hex.pm/packages/gleamy_bench>,
2329
as Glychee only allows benchmarking on target Erlang.
24-
- Glychee is dependency free except for _Benchee_ and _Elixir_.
30+
- Glychee is **dependency free** except for _Benchee_ and _Elixir_, e.g. it may
31+
be used to benchmark Gleam's stdlib.
2532
- A recent Elixir and Hex must be installed. You might be required to run
2633
`mix local.hex` after installing Elixir.
2734

@@ -100,7 +107,3 @@ in one go.
100107
## Documentation
101108

102109
**Glychee**'s documentation can be found at <https://hexdocs.pm/glychee>.
103-
104-
## License
105-
106-
[Apache 2.0](./LICENSE)

0 commit comments

Comments
 (0)