update for 1.0

Author: inoas

CHANGELOG.md

@@ -1,32 +1,38 @@
 # Changelog
 
-## 0.3.0
+## 1.0.0 - 2024-02-27
 
-- Update for Gleam 0.30.
+- Update for **Gleam** `~> 1.0`.
+- Some code cleanup and refactorings.
+- Also updates Benchee dep to `~> 1.3`.
 
-## 0.2.7
+## 0.3.0 - 2023-06-14
+
+- Update for **Gleam** `~> 0.30`.
+
+## 0.2.7 - 2023-01-20
 
 - Improved readme instructions on how to run the Glychee.
 
-## 0.2.6
+## 0.2.6 - 2023-01-01
 
 - Instruct to use `gleam add glychee --dev` to add as a dev dependency, only.
 
-## 0.2.5
+## 0.2.5 - 2023-01-01
 
-- Fix logo on hexpm
+- Fix logo on *hexpm*.
 
-## 0.2.4
+## 0.2.4 - 2023-01-01
 
 - Readme
 - Typos
 - Logo
 
-## 0.2.3
+## 0.2.3 - 2022-10-25
 
 - Now just requires Gleam 0.24.0 instead of an unreleased nightly version.
 
-## 0.2.2
+## 0.2.2 - 2022-10-25
 
 - Changed Benchee configuration settings to:
 
@@ -39,7 +45,7 @@
   ]
   ```
 
-## v0.2.0
+## v0.2.0 - 2022-10-21
 
 - Removed these dependencies: gleam's `stdlib`, `gleam_erlang`, and `gleeunit`,
   which means Glychee can be used in these projects to benchmark themselves.

README.md

@@ -15,10 +15,12 @@ Named after *Gleam*, *Benchee* and their fruity [*Lychee*](https://en.wikipedia.
 
 ## Requirements
 
-- Requires Gleam 0.30 or later.
+- Requires **Gleam 1.0** or later.
+- For benchmarking on target JavaScript see <https://hex.pm/packages/gleamy_bench>,
+  as Glychee only allows benchmarking on target Erlang.
+- Glychee is dependency free except for *Benchee* and *Elixir*.
 - A recent Elixir and Hex must be installed. You might be required to run
   `mix local.hex` after installing Elixir.
-- Only allows benchmarking of target Erlang and not target JavaScript.
 
 ## Quick start
 
@@ -28,68 +30,57 @@ Named after *Gleam*, *Benchee* and their fruity [*Lychee*](https://en.wikipedia.
    to benchmark with one or many `Data`.
 3. Run the benchmark:
 
-   ```sh
+   ```shell
    gleam clean && \
    gleam build && \
-   erl -pa ./build/dev/erlang/*/ebin -noshell -eval 'PROJECT_NAME@@main:run(my_benchmark)'
+   gleam run -m my_benchmark
    ```
 
-   ... where `PROJECT_NAME` is set via the root level `name` property in `gleam.toml`.
-
 ### Full example
 
 If you do not have a Gleam project yet, create it with:
 
-```sh
+```shell
 gleam new foobar
 cd foobar
 ```
 
-Add **Glychee**: `gleam add glychee --dev`, then in your project create a file named
-`src/benchmark.gleam` with following source code:
-
-```gleam
-if erlang {
-  import gleam/int
-  import gleam/list
-  import glychee/benchmark
-
-  pub fn main() {
-    benchmark.run(
-      [
-        benchmark.Function(
-          label: "list.sort()",
-          callable: fn(test_data) {
-            fn() {
-              list.sort(test_data, int.compare)
-            }
-          },
-        ),
-      ],
-      [
-        benchmark.Data(
-          label: "pre-sorted list",
-          data: list.range(1, 100_000),
-        ),
-        benchmark.Data(
-          label: "reversed list",
-          data: list.range(1, 100_000) |> list.reverse,
-        ),
-      ],
-    )
-  }
-}
-```
-
-Then run in your terminal via:
+To add and run a demo of **Glychee**:
+
+1. `gleam add glychee --dev`
+2. In your project create a file named `src/my_benchmark.gleam` with following source code:
+
+   ```gleam
+   import gleam/int
+   import gleam/list
+   import glychee/benchmark
+
+   pub fn main() {
+     benchmark.run(
+       [
+         benchmark.Function(label: "list.sort()", callable: fn(test_data) {
+           fn() { list.sort(test_data, int.compare) }
+         }),
+       ],
+       [
+         benchmark.Data(label: "pre-sorted list", data: list.range(1, 100_000)),
+         benchmark.Data(
+           label: "reversed list",
+           data: list.range(1, 100_000)
+             |> list.reverse,
+         ),
+       ],
+     )
+   }
+   ```
 
-```sh
-gleam clean && \
-gleam build && \
-erl -pa ./build/dev/erlang/*/ebin -noshell -eval 'PROJECT_NAME@@main:run(benchmark)'
-```
+3. Then run in your terminal via:
 
-... where `PROJECT_NAME` is set via the root level `name` property in `gleam.toml`.
+   ```shell
+   gleam clean && \
+   gleam build && \
+   gleam run -m my_benchmark
+   ```
 
 Now you can alter the functions and data specified in above's example to
 whichever function of your application or library you want to benchmark.

gleam.toml

@@ -1,14 +1,14 @@
 name = "glychee"
-version = "0.3.0"
-gleam = ">= 0.30.0"
+version = "1.0.0"
+gleam = "~> 1.0"
 licences = ["Apache-2.0"]
 description = "Glychee: Easy access to Elixir's Benchee from Gleam!"
 repository = { type = "github", user = "inoas", repo = "glychee" }
 # links = [{ title = "Website", href = "https://gleam.run" }]
 target = "erlang"
 
 [dependencies]
-benchee = "~> 1.1"
+benchee = "~> 1.3"
 
 [documentation]
 pages = [

manifest.toml

@@ -2,10 +2,11 @@
 # You typically do not need to edit this file
 
 packages = [
-  { name = "benchee", version = "1.1.0", build_tools = ["mix"], requirements = ["deep_merge", "statistex"], otp_app = "benchee", source = "hex", outer_checksum = "7DA57D545003165A012B587077F6BA90B89210FD88074CE3C60CE239EB5E6D93" },
+  { name = "benchee", version = "1.3.0", build_tools = ["mix"], requirements = ["deep_merge", "statistex", "table"], otp_app = "benchee", source = "hex", outer_checksum = "34F4294068C11B2BD2EBF2C59AAC9C7DA26FFA0068AFDF3419F1B176E16C5F81" },
   { name = "deep_merge", version = "1.0.0", build_tools = ["mix"], requirements = [], otp_app = "deep_merge", source = "hex", outer_checksum = "CE708E5F094B9CD4E8F2BE4F00D2F4250C4095BE93F8CD6D018C753894885430" },
   { name = "statistex", version = "1.0.0", build_tools = ["mix"], requirements = [], otp_app = "statistex", source = "hex", outer_checksum = "FF9D8BEE7035028AB4742FF52FC80A2AA35CECE833CF5319009B52F1B5A86C27" },
+  { name = "table", version = "0.1.2", build_tools = ["mix"], requirements = [], otp_app = "table", source = "hex", outer_checksum = "7E99BC7EFEF806315C7E65640724BF165C3061CDC5D854060F74468367065029" },
 ]
 
 [requirements]
-benchee = { version = "~> 1.1" }
+benchee = { version = "~> 1.3" }

test/glychee_test.gleam

@@ -1,5 +1,6 @@
-/// There are no tests
-///
+import glychee/helpers
+
 pub fn main() {
+  helpers.gleam_io_println("\nNotice: There are no tests!\n")
   Nil
 }