From f21a9b5b4104262d4688115ba49fd897c29c6fc6 Mon Sep 17 00:00:00 2001 From: Sayan Nandan Date: Wed, 5 Aug 2020 23:14:38 +0530 Subject: [PATCH] Update changelog and supported actions --- CHANGELOG.md | 10 +++++++++- README.md | 15 ++++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9a68e8d3..20f3e25b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,10 +4,18 @@ All changes in this project will be noted in this file. ## Version 0.3.1 [2020-08-05] -> No breaking changes +> This release introduces breaking changes This release fixes #7, #8. It also adds several under-the-hood optimizations greatly improving query performance. +### Migrating existing clients + +The only significant change in the protocol is the new metalayout format: `#a#b#c` instead of the previously proposed `a#b#c#` . + +### Disk storage format + +The disk storage format was changed rendering existing binary data files incompatible. However, if you have any existing data - which is important, open an issue - because we'll be able to provide a tool that can help you easily migrate your existing datasets - with a one line command - so - no worries! + ## Version 0.3.0 [2020-07-28] > No breaking changes diff --git a/README.md b/README.md index 9966cf06..dc02d3c8 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,15 @@ TerrabaseDB (or TDB for short) is an effort to provide the best of key/value sto 4. First run `tdb` to start the database server and then run `tsh` to start the interactive shell 5. Run commands like: `SET foo bar` , `GET bar` , `UPDATE cat mitten` or `DEL proprietary` 🤪 on `tsh` ! +## Supported actions + +* GET +* SET +* UPDATE +* DEL + +And, a lot more actions are coming soon! + ## Clients 🔌 We're officially working on a [Python Driver](https://github.com/terrabasedb/python-driver) and we plan to support more languages along the way 🎉! You're free to write your own clients - all you need to do is implement the simple and performant [Terrapipe protocol spec](https://git.io/JJZ4Z). @@ -44,7 +53,11 @@ This project strictly follows semver, however, since this project is currently i ## Contributing -**Yes - we need you!** Be it a typo, a bizarre idea, a dirty bug🐞 or an amazing patch - you're welcome to contribute to TDB! Beginner friendly issues are marked with the ![easyfix](https://img.shields.io/badge/easyfix-C71585) label. Read the guide [here](./CONTRIBUTING.md). +**Yes - we need you!** Be it a typo, a bizarre idea, a dirty bug🐞 or an amazing patch - you're welcome to contribute to TDB! Beginner friendly issues are marked with the + +![easyfix](https://img.shields.io/badge/easyfix-C71585) label. Read the guide [here](./CONTRIBUTING.md) + +. ## License