Skip to content

Commit 641b97e

Browse files
committed
Refactor the first part of the README to add two images and remove verbose words.
FossilOrigin-Name: 374ba9190dc99e1b7a6ca46e548722c29299d6bfac2b77503110adfdb0d324a8
1 parent 955fda6 commit 641b97e

File tree

3 files changed

+34
-25
lines changed

3 files changed

+34
-25
lines changed

README.md

+34-25
Original file line numberDiff line numberDiff line change
@@ -10,41 +10,50 @@
1010

1111
# LumoSQL
1212

13-
[LumoSQL](lumosql.org) is a modification (not a fork) of the
14-
[SQLite](https://sqlite.org) embedded data storage library, the [most-deployed software](https://sqlite.org/mostdeployed.html).
15-
LumoSQL adds performance, security and privacy features, partly by adding
16-
multiple backend storage systems. If you are an SQLite user familiar with C
17-
development wanting an easier way to benchmark and measure SQLite, or you want
18-
SQLite with encryption, or if you are wanting features not available in the SQLite
19-
key-value storage engine, then you may find LumoSQL interesting.
13+
[LumoSQL](lumosql.org) is a modification ([not a fork](https://lumosql.org/src/not-forking/)) of the
14+
[SQLite](https://sqlite.org) embedded data storage library, the [most-deployed software](https://sqlite.org/mostdeployed.html). We are currently in [Phase II of the project](./doc/LumoSQL-PhaseII-Announce.md).
2015

21-
In [Phase II of LumoSQL](./doc/LumoSQL-PhaseII-Announce.md) we are building on
22-
the existing optional per-row checksums to add per-row [Attribute-Based Encryption (ABE)](https://en.wikipedia.org/wiki/Attribute-based_encryption) and much more.
16+
If you are reading this on GitHub you are looking at a read-only mirror.
17+
The master is always available at [lumosql.org](https://lumosql.org/src/lumosql).
18+
LumoSQL adds security, privacy, performance and measurement features to SQLite.
2319

24-
In the existing LumoSQL 0.4 there are currently three LumoSQL backends:
20+
# Benchmarking
21+
22+
SQLite can test and compare results consistently across many kinds of system and configurations using the [Not-forking tool](https://lumosql.org/src/not-forking). Example:
23+
24+
![Example statistical result from LumoSQL benchmarking](./new-doc/images/LumoSQLBenchmarkExample.png)
25+
26+
# Pluggable backends
27+
28+
LumoSQL can swap back end key-value store engines in and out of SQLite. LMDB is
29+
the most famous (but not the only) example of an alternative key-value store,
30+
and LumoSQL can combine dozes of versions of LMDB and SQLite source code like
31+
this:
32+
33+
![Diagram of Not-forking used to create two example binaries](./new-doc/images/LumoSQL-Notforking-diagram.png)
34+
35+
In LumoSQL 0.4 there are three LumoSQL backends:
2536

2637
* the default SQLite Btree storage system
2738
* [LMDB](https://github.com/LMDB/lmdb)
28-
* [the Berkley Database](https://en.wikipedia.org/wiki/Berkeley_DB)
39+
* [the ancient Berkley Database](https://en.wikipedia.org/wiki/Berkeley_DB)
2940

30-
LumoSQL has a build and benchmarking tool for comparing vanilla SQLite versions
31-
and configurations with each other, as well as comparing the performance of
32-
different storage backends. LumoSQL is written in C, like SQLite. The
33-
benchmarking and other tools are written in Tcl, like much of the tooling and
34-
extensions for SQLite and Fossil. The build tool guarantees that options and
35-
configurations are always selected in the same way, so that benchmark results are
36-
reliable.
41+
We are looking at some interesting new development in key-value storage to add and benchmark.
3742

38-
LumoSQL is distributed under [very liberal licence terms](LICENCES/README.md).
43+
# Encryption and corruption detection, optionally per-row
3944

40-
LumoSQL is supported by the [NLNet Foundation](https://nlnet.nl).
45+
LumoSQL adds modern encryption to SQLite, including [Attribute-Based Encryption
46+
(ABE)](https://en.wikipedia.org/wiki/Attribute-based_encryption). This can be
47+
done on a per-row basis, and also includes per-row checksums so that any error
48+
can be noticed quickly and located down to the individual row. Per-row
49+
checksums also make some search and comparison operations much faster.
50+
51+
# Organised and Supported
4152

42-
If you are reading this on GitHub, then you are looking at a read-only mirror.
43-
The non-Git master is always available at [lumosql.org](https://lumosql.org/src/lumosql).
53+
LumoSQL is distributed under [very liberal MIT licence terms](LICENCES/README.md).
54+
55+
LumoSQL is supported by the [NLNet Foundation](https://nlnet.nl).
4456

45-
Neither Windows nor Android are supported at present, despite being important
46-
SQLite targets. We do plan to do so, and in addition contributors are most
47-
welcome via the [LumoSQL Fossil site](/).
4857

4958
# Table of Contents
5059

47.9 KB
Loading
115 KB
Loading

0 commit comments

Comments
 (0)