Merge pull request #67 from RadicalZephyr/main

Add a CHANGELOG and more keywords and categories to toml

CHANGELOG.md

@@ -0,0 +1,127 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- This CHANGELOG file.
+- Dependency on [parking-lot].
+
+[parking-lot]: https://crates.io/crates/parking-lot
+
+### Changed
+
+- Various small performance improvements.
+
+## [2.1.2] - 2022-11-27
+
+### Added
+
+- Added basic documentation for every public API [#62]
+
+### Fixed
+
+- Removed several API items related to internal dependency tracking
+  from the documentation.
+- Fixed garbage collector bug that was causing the time taken by every
+  transaction to increase exponentially with the number of nodes in
+  the graph. [#62]
+
+[#62]: https://github.com/SodiumFRP/sodium-rust/pull/62
+
+
+## [2.1.1] - 2020-10-27
+
+### Fixed
+
+- Fixed `Listener` memory management when using `Operational::defer`.
+
+
+## [2.1.0] - 2020-07-28
+
+### Added
+
+- Added methods for sampling up to 6 `Cell`s from one
+  `Stream::snapshot`. [#43]
+- Add a Drop-based `Transaction` scope. [#53]
+- Added `Stream::split` method for flattening a `Stream<impl
+  IntoIterator<Item = T>` into a `Stream<T>`. [#44]
+- Added missing public `SodiumCtx::post` method. [#42]
+- Added `Router`, a more performant way of splitting one `Stream` into
+  many `Stream`s.
+
+[#43]: https://github.com/SodiumFRP/sodium-rust/issues/43
+[#53]: https://github.com/SodiumFRP/sodium-rust/issues/53
+[#44]: https://github.com/SodiumFRP/sodium-rust/issues/44
+[#42]: https://github.com/SodiumFRP/sodium-rust/issues/42
+[#57]: https://github.com/SodiumFRP/sodium-rust/issues/57
+
+
+## [2.0.2] - 2020-07-25
+
+### Fixed
+
+- Correctly use `Lazy` values in `CellLoop::loop`. [#45]
+
+[#45]: https://github.com/SodiumFRP/sodium-rust/issues/45
+
+
+## [2.0.1] - 2020-04-24
+
+### Added
+
+- Added missing `Clone` impl for `SodiumCtx`.
+
+### Fixed
+
+- Track dependencies correctly in `Stream::listen`.
+
+
+## [2.0.0] - 2020-04-21
+
+Version 2 rewrite.
+
+
+## [1.0.1] - 2018-11-24
+
+### Added
+
+- Added `Transaction::is_active` method. [#26]
+
+### Changed
+
+- Disallow calling `send` in Sodium callbacks, use `post` to make it
+  happen in the next transaction instead. [#32]
+
+### Fixed
+
+- Fixed `SampleLazy` bug. [#23]
+- Fixed `IsCell::listen_weak` now correctly uses `Cell::listen_weak`. [#30]
+- Keep `SodiumCtx` alive in memory when any Sodium objects are alive. [#29]
+
+[#23]: https://github.com/SodiumFRP/sodium-rust/issues/23
+[#26]: https://github.com/SodiumFRP/sodium-rust/issues/26
+[#29]: https://github.com/SodiumFRP/sodium-rust/issues/29
+[#30]: https://github.com/SodiumFRP/sodium-rust/issues/30
+[#32]: https://github.com/SodiumFRP/sodium-rust/issues/32
+[#34]: https://github.com/SodiumFRP/sodium-rust/issues/34
+
+
+## [1.0.0] - 2018-11-17
+
+Initial release.
+
+[Unreleased]: https://github.com/SodiumFRP/sodium-rust/compare/v2.1.2...HEAD
+[2.1.2]: https://github.com/SodiumFRP/sodium-rust/compare/2.1.1...2.1.2
+[2.1.1]: https://github.com/SodiumFRP/sodium-rust/compare/2.1.0...2.1.1
+[2.1.0]: https://github.com/SodiumFRP/sodium-rust/compare/2.0.2...2.1.0
+[2.0.2]: https://github.com/SodiumFRP/sodium-rust/compare/2.0.1...2.0.2
+[2.0.1]: https://github.com/SodiumFRP/sodium-rust/compare/2.0.0...2.0.1
+[2.0.0]: https://github.com/SodiumFRP/sodium-rust/compare/1.0.1...2.0.0
+[1.0.1]: https://github.com/SodiumFRP/sodium-rust/compare/1.0.0...1.0.1
+[1.0.0]: https://github.com/SodiumFRP/sodium-rust/releases/tag/v1.0.0

Cargo.toml

@@ -1,15 +1,14 @@
 [package]
 name = "sodium-rust"
 version = "2.1.2"
-authors = ["Clinton Selke <[email protected]>"]
+authors = ["Clinton Selke <[email protected]>", "Zefira Shannon <[email protected]>"]
 edition = "2021"
 license = "BSD-3-Clause"
 repository = "https://github.com/SodiumFRP/sodium-rust"
-keywords = ["frp"]
+categories = ["asynchronous", "rust-patterns"]
+keywords = ["frp", "functional", "reactive", "observer", "events"]
 description = "Sodium FRP (Functional Reactive Programming)"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 log = "0.4.8"
 parking_lot = "0.12.1"