diff --git a/README.md b/README.md index b8bc056..a8305fb 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,16 @@ [![Package Version](https://img.shields.io/hexpm/v/rememo)](https://hex.pm/packages/rememo) [![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/rememo/) -This is a basic memoization method for Gleam on the Erlang target, using an actor to cache and reuse the results of function calls when possible. +This is a basic [memoization](https://en.wikipedia.org/wiki/Memoization) method for Gleam on the Erlang target, for caching and reusing the results of function calls when possible. -There is some overhead to sending messages and caching the dictionary of results, but in situations that call for it, like dynamic programming problems where the same basic subproblem recurs hundreds or thousands of times, the tradeoff is worthwhile. Always benchmark your code when in doubt. +Adding to and reading from the memoization cache incurs some overhead, but in situations that call for it, like dynamic programming problems where the same basic subproblem recurs hundreds or thousands of times, the tradeoff is worthwhile. Always benchmark your code when in doubt. ```sh gleam add rememo ``` + ```gleam -import memo/ets/memo // This is the recommended implementation to use +import rememo/ets/memo // This is the recommended implementation to use import gleam/io pub fn main() { @@ -37,4 +38,4 @@ Further documentation can be found at . ## Contributing and development -Suggestions and pull requests are welcome. \ No newline at end of file +Suggestions and pull requests are welcome. diff --git a/gleam.toml b/gleam.toml index 3c1fb4f..ffc7578 100644 --- a/gleam.toml +++ b/gleam.toml @@ -4,7 +4,7 @@ version = "2.0.0" # Fill out these fields if you intend to generate HTML documentation or publish # your project to the Hex package manager. # -description = "Simple OTP-based memoization for Gleam" +description = "Simple memoization for Gleam" licences = ["Apache-2.0"] target = "erlang" repository = { type = "github", user = "hunkyjimpjorps", repo = "rememo" }