diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e3cfb56 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,21 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). + +## Unreleased + +### Changed +* **Breaking**: `relay` was renamed to `bonsol-node`. +* **Breaking**: `relaykp.json` was renamed to `node_keypair.json`, and is no longer recognized by that name. +* **Breaking**: `bonsol-channel` was renamed to `bonsol`. +* **Breaking**: `bonsol-channel-interface` and `bonsol-channel-utilities` were merged into a single crate, `bonsol-interface`. +* `run-relay.sh`, a script for building and running a bonsol node was renamed to `run-node.sh`. +* **Breaking**: Proving and input resolution functionality was removed from `bonsol-sdk`, and placed in a new crate, `bonsol-prover`. +* Naming conventions across the board were updated in documentation accordingly. + +### Added +* A nix flake was added which brings with it a development environment and CI checks. +* A contributing guide was added to the docs, and linked to the README.md at the root of the project. +