Skip to content

Commit

Permalink
docs: update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rorycl committed Jan 22, 2025
1 parent 60d80b9 commit e26088a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 21 deletions.
17 changes: 7 additions & 10 deletions CHANGELOG.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
Changelog for release v0.2.6
Changelog for release v0.2.8

Update to use decimal.Decimal rather than int to support cheaper items
on Cex which have decimal prices.
Update to show distance to stores when a postcode is supplied.

* go: update modules
* web: update int pricing to use decimal.Decimal
* console: update int pricing to use decimal.Decimal
* cli: update int pricing to use decimal.Decimal
* query: bubble up json unmarshall errors properly
* cex: change int pricing to decimal.Decimal, update tests accordingly
* testdata: add example data json file with decimal results
* Store locations are cached in a goroutine safe manner.
* Store postcode lookups are cached in a goroutine safe manner.

The clients have been altered to show distances to stores where
appropriate, and new gifs generated!
30 changes: 19 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# cexfind

v0.2.7 : 19 January 2025 : add model to searchables
v0.2.8 : 22 January 2025 : add store distances

If you supply a postcode, cexfind will show the distance to stores from
that location. The store locations are updated daily in local cache,
so should be pretty fast to lookup.

The lookup for the supplied postcode uses
[api.postcodes.io](https://api.postcodes.io/). Let's see how that goes.

## Find kit on Cex, fast

Expand All @@ -25,6 +32,17 @@ build for your local machine using `make build-all` if you have go (>=

## Clients

**web server**

A simple htmx webserver client.

Run `./bin/webserver` or the windows alternative to run the server
locally on the default local ip address of `127.0.0.1` and port `8000`.
Use the command line switches to change these options. (Use `-h` to see
the switches.)

<img width="1000" src="cmd/web/web.gif" />

Three clients are provided for the very simple `cexfind` golang module:

**console**
Expand All @@ -44,16 +62,6 @@ Run `./bin/cli -h` or the windows alternative to see the switch options.

<img width="1000" src="cmd/cli/cli.gif" />

**web server**

A simple htmx webserver client.

Run `./bin/webserver` or the windows alternative to run the server
locally on the default local ip address of `127.0.0.1` and port `8000`.
Use the command line switches to change these options. (Use `-h` to see
the switches.)

<img width="1000" src="cmd/web/web.gif" />

## Licence

Expand Down

0 comments on commit e26088a

Please sign in to comment.