Skip to content

Commit

Permalink
docs: update readme, changelog, and package urls
Browse files Browse the repository at this point in the history
  • Loading branch information
Hertzole committed Jan 17, 2024
1 parent 920e1b6 commit a31c3d3
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
7 changes: 6 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
## [1.3.0] - Unreleased
## [1.3.0] - 2024-01-17

### Added

- Added `SetValueWithoutNotify` to `ValueReference<T>` to allow you to set the value without invoking the change event
- Added `EnsureCapacity` to `ScriptableList<T>`

### Fixed

Expand All @@ -11,6 +12,10 @@
- Fixed the package not having an author
- Fixed allocation when using `foreach` on scriptable lists and dictionaries

### Removed

- Removed obsolete `ResetValues` from `RuntimeScriptableObject`

## [1.2.0] - 2023-05-20

### Added
Expand Down
5 changes: 4 additions & 1 deletion Packages/se.hertzole.scriptable-values/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@
"name": "se.hertzole.scriptable-values",
"version": "1.3.0",
"displayName": "Scriptable Values",
"description": "Set up games using Scriptable Objects.",
"description": "Scriptable Values allow you to use scriptable objects for reactive values, events, and collections instead of normal C# events and singletons.\n\nYou also don't need to care about values being saved between sessions as they are cleared before you enter play mode, but this is also customizable!",
"unity": "2021.3",
"unityRelease": "0f1",
"changelogUrl": "https://github.com/Hertzole/scriptable-values/blob/master/CHANGELOG.md",
"documentationUrl": "https://github.com/Hertzole/scriptable-values/blob/master/README.md",
"licensesUrl": "https://github.com/Hertzole/scriptable-values/blob/master/LICENSE.md",
"keywords": [
"scriptableobject",
"scriptable",
Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ You also don't need to care about values being saved between sessions as they ar
- Value reference type for easily picking between a constant value and a scriptable object reference
- Automatically collect stack traces to see where your values are set from
- Value and event listeners for easily hooking up events in the editor for when value changes/events are invoked
- Supports addressables for scriptable values and events

## 📦 Installation

Expand Down Expand Up @@ -62,6 +63,9 @@ Otherwise, follow these instructions:
3. Paste in `https://github.com/Hertzole/scriptable-values.git#package`
You can also use `https://github.com/Hertzole/scriptable-values.git#dev-package` if you want the latest (but unstable!) changes.


Also check out my other package [Unity Toolbox](https://github.com/Hertzole/unity-toolbox#subscribe-methods-generator) that can generate subscribe methods for scriptable values and events!

## 🛠 Usage

### Scriptable Values
Expand Down Expand Up @@ -346,6 +350,6 @@ public class PauseManager : MonoBehaviour
}
```

## ♥ Support
## 📃 License

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/I2I4IHAK)
[MIT](https://github.com/Hertzole/scriptable-values/blob/master/LICENSE.md)

0 comments on commit a31c3d3

Please sign in to comment.