Skip to content

Commit bd2efe1

Browse files
committed
Update readme
1 parent 12eb3cd commit bd2efe1

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It has been tested with Arduino Uno with SparkFun MicroSD Shield, WeMos ESP8266
1111
# Features
1212

1313
- Low Memory requirement: `page_size` + some stack
14-
- Can log using Arduino UNO (2kb RAM) with 512kb page size
14+
- Can log using Arduino UNO (`2kb` RAM) with 512 bytes page size
1515
- Can do quick binary search on RowID or Timestamp without any index in logarithmic time
1616
- Recovery possible in case of power failure
1717
- Rolling logs are possible (not implemented yet)
@@ -29,6 +29,10 @@ For example, locating any record in a 70 MB db having 1 million records on Ardui
2929

3030
The examples `ESP8266_Console` and `ESP32_Console` can be used to log and retrieve from ESP8266 and ESP32 boards respectively on Micro SD and SPIFFS filesystems.
3131

32+
# API
33+
34+
For finding out how the logger works and a complete description of API visit [Sqlite Micro Logger C Library](https://github.com/siara-cc/sqlite_micro_logger_c).
35+
3236
# Ensuring integrity
3337

3438
If there is power failure during logging, the data can be recovered using `Recover database` option in the menu.
@@ -42,7 +46,14 @@ Following are limitations of this library:
4246
- `Select`, `Insert` are not supported. Instead C API similar to that of Sqlite API is available.
4347
- Index creation and lookup not possible (as of now)
4448

45-
However, the database created can be copied to a desktop PC and further operations such as index creation and summarization can be carried out from there as though its a regular Sqlite database.
49+
However, the database created can be copied to a desktop PC and further operations such as index creation and summarization can be carried out from there as though its a regular Sqlite database. But after doing so, it may not be possible to use it with this library any longer.
50+
51+
# Future plans
52+
53+
- Index creation when finalizing a database
54+
- Allow modification of records
55+
- Rolling logs
56+
- Show how this library can be used in a multi-core, multi-threaded environment
4657

4758
# Support
4859

sqlite_ulogger_promo.png

-4.25 KB
Loading

0 commit comments

Comments
 (0)