change import to gleamy/bench

schurhammer · Dec 4, 2023 · c415008 · c415008
1 parent ae85678
commit c415008
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+# Changelog
+
+# v0.3.0 2023.12.05
+
+- Change import structure from `import gleamy_bench` to `import gleamy/bench`
+- Increase default benchmark duration to 2000ms, warmup to 500ms.
diff --git a/README.md b/README.md
@@ -8,20 +8,18 @@ A library for benchmarking gleam code.
 # How To
 
 ```rust
+import gleamy/bench
+
+...
 
 bench.run(
-    [
-      bench.Input("pre-sorted list", list.range(1, 100_000)),
-      bench.Input("reversed list", list.range(1, 100_000) |> list.reverse),
-    ],
-    [
-        bench.Function("list.sort()", sort_int)
-    ],
-    [
-        bench.Duration(1000),
-        bench.Warmup(100)
-    ],
-  )
+  [
+    bench.Input("pre-sorted list", list.range(1, 100_000)),
+    bench.Input("reversed list", list.reverse(list.range(1, 100_000))),
+  ],
+  [bench.Function("list.sort()", sort_int)],
+  [bench.Duration(1000), bench.Warmup(100)],
+)
 |> bench.table([bench.IPS, bench.Min, bench.P(99)])
 |> io.println()
 

diff --git a/gleam.toml b/gleam.toml
@@ -1,5 +1,5 @@
 name = "gleamy_bench"
-version = "0.2.0"
+version = "0.3.0"
 
 # Fill out these fields if you intend to generate HTML documentation or publish
 # your project to the Hex package manager.

diff --git a/src/gleamy_bench.gleam → src/gleamy/bench.gleam b/src/gleamy_bench.gleam → src/gleamy/bench.gleam
diff --git a/src/gleamy_bench_example.gleam b/src/gleamy_bench_example.gleam
@@ -1,4 +1,4 @@
-import gleamy_bench as bench
+import gleamy/bench
 import gleam/io
 import gleam/int
 import gleam/list
@@ -11,11 +11,7 @@ pub fn main() {
   bench.run(
     [
       bench.Input("pre-sorted list", list.range(1, 100_000)),
-      bench.Input(
-        "reversed list",
-        list.range(1, 100_000)
-        |> list.reverse,
-      ),
+      bench.Input("reversed list", list.reverse(list.range(1, 100_000))),
     ],
     [bench.Function("list.sort()", sort_int)],
     [bench.Duration(1000), bench.Warmup(100)],