Skip to content

Commit

Permalink
Prepare for Release v0.1.2
Browse files Browse the repository at this point in the history
Updated `CHANGELOG.md` to include a section for the upcoming version.

Edited `cargo.toml`, changing the version number from `0.1.0` to
`0.1.1`.

Added an explanation of the new `minimum` setting to `README.md`.
  • Loading branch information
subreme committed Dec 21, 2021
1 parent 3cff865 commit 5a35f0e
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 6 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.1.2] - 2021-12-21

### Added

- `minimum` field in `Settings`, which controls the minimum number of
Expand Down Expand Up @@ -48,6 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

Initial release.

[Unreleased]: https://github.com/subreme/shopify-monitor/compare/0.1.1...HEAD
[Unreleased]: https://github.com/subreme/shopify-monitor/compare/0.1.2...HEAD
[0.1.2]: https://github.com/subreme/shopify-monitor/compare/0.1.1...0.1.2
[0.1.1]: https://github.com/subreme/shopify-monitor/compare/0.1.0...0.1.1
[0.1.0]: https://github.com/subreme/shopify-monitor/releases/tag/0.1.0
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "shopify-monitor"
version = "0.1.1"
version = "0.1.2"
edition = "2018"
description = ""
repository = "https://github.com/subreme/shopify-monitor"
Expand Down
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ Let's start by looking at a complete Config Example:
"footer_text": "subreme/shopify-monitor",
"footer_image": "https://avatars.githubusercontent.com/u/71085002",
"timestamp": true,
"minimum": 0,
"keywords": null
},
"channels": [
Expand Down Expand Up @@ -219,11 +220,13 @@ Let's start by looking at a complete Config Example:
```

*Note: some values in this purposely "complete" example had values of
`false`. This is completely unnecessary, as every
`false` or `0`. This is completely unnecessary, as every
[boolean](https://en.wikipedia.org/wiki/Boolean) value in the config
file (with the exception of `combine`, which will be explained later)
defaults to `false`, so that you only have to include the toggles you
want, without having to worry about disabling features you don't want.*
defaults to `false` and every
[integer](https://en.wikipedia.org/wiki/Integer) one defaults to 0, so
that you only have to include the toggles you want, without having to
worry about disabling features you don't want.*

This might seem overwhelming, as it was designed to fit in necessary
values so that it the format will *[hopefully]* work in future versions
Expand Down Expand Up @@ -348,6 +351,7 @@ example:
"footer_text": "subreme/shopify-monitor",
"footer_image": "https://avatars.githubusercontent.com/u/71085002",
"timestamp": true,
"minimum": 0,
"keywords": null
},
"channels": [
Expand Down Expand Up @@ -538,6 +542,9 @@ Every settings object contains the following fields:
footer, however this should be tested along with your footer message
on [Discohook](https://discohook.com), as in some cases it could look
unpleasant.
- *`minimum`*: if a value is set, webhooks will only be sent out if the
number of variants available for a restocked product is greater than
or equal to it.
- *`keywords`*: when implemented in a future version of the monitor,
you'll be allowed to select keywords here, so that only products that
match the specified cases will have webhooks sent.
Expand Down Expand Up @@ -573,6 +580,7 @@ the following snippet:
"footer_text": null,
"footer_image": null,
"timestamp": null,
"minimum": null,
"keywords": null
}
```
Expand Down

0 comments on commit 5a35f0e

Please sign in to comment.