From b9c04a48f3386a652d1dc1941e510d320f0dc8ae Mon Sep 17 00:00:00 2001 From: sashaferrum <51423022+sashaferrum@users.noreply.github.com> Date: Fri, 22 Sep 2023 14:41:04 +0200 Subject: [PATCH] update readme --- README.md | 5 +++-- pyproject.toml | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f5698a2..36bb729 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # A FSM Storage for aiogram 3.0+ -It's a very simple FSM Storage for the aiogram 3.0+. It uses local SQLite database for storing states and data. And using 'pickle' libruary for serializing objects. It's sutable for small and simple projects. +It's a very simple FSM Storage for the aiogram 3.0+. It uses local SQLite database for storing states and data. It's possible to chose method of serializing data in the database. A 'picle' or a 'json' are available. A 'picle' is used as default. ## Installation: ```bash @@ -16,7 +16,8 @@ from aiogram_sqlite_storage.sqlitestore import SQLStorage # Initialise a storage # Path to a database is optional. 'fsm_starage.db' will be created for default. -my_storage = SQLStorage('my_db_path.db') +# 'serializing_method' is optional. 'picle' is a default value. Also a 'json' is possible. +my_storage = SQLStorage('my_db_path.db', serializing_method = 'picle') # Initialize dispetcher with the storage dp = Dispatcher(storage = my_storage) diff --git a/pyproject.toml b/pyproject.toml index 82b209f..821ef2b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,11 +4,11 @@ build-backend = "hatchling.build" [project] name = "aiogram_sqlite_storage" -version = "0.2.1" +version = "0.9.0" authors = [ { name="Aleksandr Zheleznov" }, ] -description = "A FSM Storage for aiogram 3.0+, based on SQLite and picle." +description = "A FSM Storage for aiogram 3.0+, based on SQLite." readme = "README.md" requires-python = ">=3.8" classifiers = [