From 7b4628c08dc280c513544f99a2e165a4e15cdada Mon Sep 17 00:00:00 2001 From: Caleb Bassi Date: Wed, 28 Nov 2018 21:13:29 -0800 Subject: [PATCH] Add changelog --- CHANGELOG.md | 7 +++++++ README.md | 4 ++-- 2 files changed, 9 insertions(+), 2 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..472fb51 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,7 @@ +## 18/11/28 + +- Migrated from Dep to vgo +- Overhauled the event system + - check the wiki/readme/examples for details +- Renamed Par to Paragraph +- Renamed MBarChart to StackedBarChart diff --git a/README.md b/README.md index 2f9da50..419cad0 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ `termui` is a cross-platform, easy-to-compile, and fully-customizable terminal dashboard built on top of [termbox-go](https://github.com/nsf/termbox-go). It is inspired by [blessed-contrib](https://github.com/yaronn/blessed-contrib) and written purely in Go. +**termui is currently undergoing some API changes so make sure to check the changelog when upgrading** + ## Installation It's recommended to install from the master branch: @@ -14,8 +16,6 @@ It's recommended to install from the master branch: go get -u github.com/gizak/termui@master ``` -Note that termui is currently undergoing some API changes so be prepared for things to break if you upgrade. - ## Usage ### Hello World