Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
citrusvanilla committed Apr 13, 2024
1 parent e681474 commit 5452c1b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/source/internals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ TinyFlux ships with two types of storage:
To use the CSV store, pass a filepath during TinyFlux initialization.

>>> my_database = "db.csv"
>>> db = TinyDB(my_database)
>>> db = TinyFlux(my_database)

To use the memory store:

>>> from tinydb.storages import MemoryStorage
>>> db = TinyDB(storage=MemoryStorage)
>>> from tinyflux.storages import MemoryStorage
>>> db = TinyFlux(storage=MemoryStorage)

In nearly all cases, users should opt for the former as it persists the data on disk.

Expand Down

0 comments on commit 5452c1b

Please sign in to comment.