Skip to content

Commit 3246365

Browse files
committed
added information to README
1 parent 0914f45 commit 3246365

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ implementation can be hidden. Instead, a dictionary or a tuple will probably be
1111
By default the module uses [SQLite3](https://www.sqlite.org/) as a database, but it can [support any of the ones
1212
supported by SQLALchemy](https://docs.sqlalchemy.org/en/latest/core/engines.html).
1313

14+
## Database
15+
16+
Currently SQLite defaults as the default database. It's a local database saved to a `.db` file. You can open and view
17+
their content using
18+
19+
## Python Google Protocol Buffer Message() Class Document
20+
21+
Google provides document on the Python Protobuf classes: <https://developers.google.com/protocol-buffers/docs/reference/python/>.
22+
The [Message() class](https://developers.google.com/protocol-buffers/docs/reference/python/google.protobuf.message.Message-class)
23+
is of particular use.
24+
1425
## KeyValueDatabaseInterface Methods
1526

1627
`KeyValueDatabaseInterface()`: An interface class for a simple Key-Value Relational Database. Has several different
@@ -56,8 +67,8 @@ CRUD methods
5667
* return: void
5768

5869

59-
## Example
70+
## Examples
6071

6172
There are two example python files in the project:
6273
* `example.py` shows how to use the custom Key-Value interface; and
63-
* `example_protobuf.py` shows how add a serialized protocol buffer.
74+
* `example_protobuf.py` shows how add a serialized protocol buffer.

0 commit comments

Comments
 (0)