inaugural 0.1.0 release!0.1.0

add doc comments for public items, record changelog, and lets ship this!!

1 files changed, 8 insertions, 0 deletions

diff --git a/CHANGELOG b/CHANGELOG
index c846cdb..3fd659a 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -8,6 +8,14 @@
 * support x86_32 `pusha`/`popa`
 * support x86_32 BCD instructions
   - for `aam`/`aad`, the undocumented `amx` and `adx` forms are used in all cases, including when the base is 10
+* begin some proper documentation for public items
+
+/!\ BREAKING CHANGES /!\
+* `RegisterBank` is no longer public. `RegisterClass` should be a suitable
+  replacement, accessible via `reg.class()`, with the register class name
+  available by `reg.class().name`, and size available by `reg.class().width()`.
+  `reg.width()` still works, and just forwards to `reg.class().width()`.
+* the field `opcode` of `Instruction` is no longer public. it can now be accessed by `inst.opcode()`.
 
 ## 0.0.15