Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sashaferrum committed Sep 22, 2023
1 parent d2999bd commit b9c04a4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [
Expand Down

0 comments on commit b9c04a4

Please sign in to comment.