doc/README: fill in current statuses

This commit is contained in:
mappu 2024-06-08 15:09:26 +12:00
parent 617393b627
commit 841575700e

View File

@ -1,27 +1,41 @@
# yvbolt # yvbolt
A graphical browser for [Bolt databases](https://github.com/etcd-io/bbolt) using [GoVCL](https://z-kit.cc/en/). A graphical browser for multiple databases using [GoVCL](https://z-kit.cc/en/).
This is an experimental application and you should generally prefer to use [qbolt](https://code.ivysaur.me/qbolt). This is an experimental application and you should generally prefer to use [qbolt](https://code.ivysaur.me/qbolt).
## Features ## Features
- Supports Bolt databases using the upstream etcd.io/bbolt library - Native desktop application, running on Linux, Windows, and macOS
- Browse database content - Supported databases:
- Recursive bucket support - Bolt
- Safe handling for non-UTF8 key and data fields - Full compatibility via the upstream [etcd-io/bbolt](https://github.com/etcd-io/bbolt) library
- No CGO for easy cross-compilation - Browse database content
- Permissive ISC license - Recursive bucket support
- Safe handling for non-UTF8 key and data fields
- SQLite
- Browse table content
## License
The code in this project is licensed under the ISC license (see `LICENSE` file for details).
This project redistributes images from the famfamfam/silk icon set under the [CC-BY 2.5 license](http://creativecommons.org/licenses/by/2.5/).
## Usage ## Usage
1. `go build` 1. `CGO_ENABLED=1 go build`
2. [Download liblcl](https://github.com/ying32/govcl/releases/download/v2.2.3/liblcl-2.2.3.zip) for your platform, or [compile it yourself](https://github.com/ying32/liblcl) (tested with v2.2.3) 2. [Download liblcl](https://github.com/ying32/govcl/releases/download/v2.2.3/liblcl-2.2.3.zip) for your platform, or [compile it yourself](https://github.com/ying32/liblcl) (tested with v2.2.3)
3. Place the liblcl library file in the same directory as `yvbolt` 3. Place the liblcl library file in the same directory as `yvbolt`
4. Run `yvbolt` and use the main menu to open a database 4. Run `yvbolt` and use the main menu to open a database
## Changelog ## Changelog
2024-06-08 v0.2.0
- Add SQLite support (now requires CGo)
- Add images for menu and navigation items
2024-06-03 v0.1.0 2024-06-03 v0.1.0
- Initial public release - Initial public release