From f137bf357376386814c644ee58bc03ce90d8c11e Mon Sep 17 00:00:00 2001
From: Ivan Nedosekov <ivan-nedd@mail.ru>
Date: Sat, 11 Feb 2023 21:47:13 +0300
Subject: [PATCH] update readme

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index e69de29..f7b202d 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,33 @@
+# Privileges manipulation with SQLalchemy
+
+Add `grant/revoke privileges` construct
+
+## Usage
+
+Examples:
+```python
+>>> from sqlalchemy import *
+>>> from sqlalchemy_privileges import *
+
+>>> str(GrantPrivileges('insert', Table('a', MetaData(schema='schema')), 'my.name'))
+'GRANT INSERT ON schema.a TO "my.name"\n'
+
+>>> str(RevokePrivileges(['insert', 'update'], table('a'), ['my.name', 'my.friend']))
+'REVOKE INSERT, UPDATE ON a TO "my.name", "my.friend"\n'
+
+>>> str(GrantPrivileges('all', table('a'), ['my.name', 'my.friend']))
+'GRANT ALL ON a TO "my.name", "my.friend"\n'
+```
+
+## Installation
+
+`sqlalchemy-privileges` is available on PyPI and can be installed via `pip`
+
+```console
+pip install sqlalchemy-privileges
+```
+
+## Acknowledgements
+Package inspired by [sqlalchemy-views](https://pypi.org/project/sqlalchemy-views/) 
+
+And thank you to the various [contributors](https://github.com/GrozniyToaster/sqlalchmey-privileges/pulse)!
\ No newline at end of file